Rebilly REST

Abandon an invoice

Abandon an invoice with specified identifier string.

Accept a KYC document

Marks that status of the document as `accepted`. Updates the review time and reviewer information. Intended to be used for manual overrides.

Apply a transaction to an invoice

Apply a transaction to an invoice. The invoice must be unpaid. The transaction must have a non-zero unused amount (not fully applied to other invoices).

Cancel a coupon redemption

Create a Bank Account

Create a Bank Account.

Create a blocklist

Create a blocklist.

Create a coupon

Create a coupon.

Create a credential

Create a credential.

Create a customer (without an ID)

Create a customer without a predefined ID. The customer's primary address will be used as the default address for payment instruments, subscriptions and invoices if none are provided. If you wish to create the customer with a predefined ID (which we recommend to prevent duplication), you may use our `PUT` request described below. Read our guide to [preventing duplicates](https://api-guides.rebilly.com/core-concepts/preventing-duplicates) to understand more.

Create a customer Timeline comment or custom defined event

Create a customer Timeline comment or custom defined event.

Create a dispute

Create a dispute.

Create a file

Additionally, a file can be sent with:. - multipart/form-data POST request: in this case all property names are the same as the JSON ones (`file` is an uploaded file) - file body request: the file body is sent as the request body, with the appropriate `Content-Type`. No additional properties can be set along the request data The following file types only are allowed: - jpg - png - gif - pdf - mp3 If using a Publishable Api Key, only private files can be created. The files can later on be modified or used using a secret API key.

Create a KYC Document

Create a KYC Document.

Create a KYC Request

Create a KYC Request.

Create a Payment Card

Create a Payment Card.

Create a ThreeDSecure entry

Create a ThreeDSecure entry.

Create an Attachment

Create an Attachment.

Create an invoice

Create an invoice.

Create an invoice item

Create an invoice item.

Create an invoice Timeline comment

Create an invoice Timeline comment.

Create Customer Timeline custom event type

Create Customer Timeline custom event type.

Deactivate a Bank Account

Deactivate a Bank Account.

Deactivate a Payment Card

Deactivate a Payment Card.

Get transaction amounts allocated to an invoice

Get the precise amounts from a transaction allocated as invoice payments.

Issue an invoice

Issue an invoice with specified identifier string. It must be in `draft` status.

Read current authentication options

Read current authentication options.

Recalculate an invoice

Recalculate an invoice with specified identifier string. It will recalculate shipping rates, taxes, discounts. It is useful when coupon was revoked or customer redeemed coupon after invoice was issued and you want to apply it to this invoice.

Redeem a coupon

Redeem a coupon.

Reissue an invoice

Reissue an invoice with specified identifier string. It must be issued. (status must be `unpaid` or `past-due`).

Reject a KYC document

Marks that status of the document as `rejected`. Updates the review time and reviewer information. Intended to be used for manual overrides.

Retrieve a Bank Account

Retrieve a Bank Account with specified identifier string.

Retrieve a blocklist

Retrieve a blocklist with specified identifier string.

Retrieve a coupon

Retrieve a coupon with specified coupon ID string.

Retrieve a coupon redemption with specified identifier string

Retrieve a credential

Retrieve a credential with specified identifier string.

Retrieve a Custom Field

Retrieve a schema of the given Custom Field for the given resource type.

Retrieve a customer

Retrieve a customer with specified identifier string.

Retrieve a customer Timeline message

Retrieve a customer message with specified identifier string.

Retrieve a customer's Lead Source

Retrieve a Lead Source of given customer.

Retrieve a dispute

Retrieve a dispute with specified identifier string.

Retrieve a File Record

Retrieve a File with specified identifier string.

Retrieve a KYC Document

Retrieve a KYC document with specified identifier string.

Retrieve a KYC request

Retrieve a KYC request with specified identifier string.

Retrieve a list of Attachments

Retrieve a list of attachments. You may sort by the id, name, relatedId, relatedType, fileId, createdTime, and updatedTime.

Retrieve a list of bank accounts

Retrieve a list of Bank Accounts.

Retrieve a list of blocklists

Retrieve a list of blocklists.

Retrieve a list of cancellations

Retrieve a list of cancellations for all subscriptions.

Retrieve a list of coupon redemptions

Retrieve a list of coupons

Retrieve a list of coupons.

Retrieve a list of credentials

Retrieve a list of credentials.

Retrieve a list of customer timeline custom event types

Retrieve a list of customer timeline custom event types.

Retrieve a list of customer timeline messages

Retrieve a list of customer timeline messages.

Retrieve a list of customer timeline messages for all customers

Retrieve a list of customer timeline messages for all customers.

Retrieve a list of customers

Retrieve a list of customers.

Retrieve a list of disputes

Retrieve a list of disputes.

Retrieve a list of files

Retrieve a list of files.

Retrieve a list of invoice timeline messages

Retrieve a list of invoice timeline messages.

Retrieve a list of invoices

Retrieve a list of invoices.

Retrieve a list of KYC documents

Retrieve a list of KYC documents.

Retrieve a list of KYC requests

Retrieve a list of KYC requests.

Retrieve a list of order timeline messages

Retrieve a list of order timeline messages.

Retrieve a list of orders

Retrieve a list of orders.

Retrieve a list of Payment Cards

Retrieve a list of Payments Cards.

Retrieve a list of payment instruments

Retrieve a list of payment instruments.

Retrieve a list of PayPal accounts

Retrieve a list of PayPal Accounts.

Retrieve a list of plans

Retrieve a list of plans.

Retrieve a list of products

Retrieve a list of products.

Retrieve a list of reactivations

Retrieve a list of reactivations for all subscriptions.

Retrieve a list of tags

Retrieve a list of tags.

Retrieve a list of ThreeDSecure entries

Retrieve a list of transaction timeline messages

Retrieve a list of transaction timeline messages.

Retrieve a list of transactions

Retrieve a list of transactions.

Retrieve a Payment Card

Retrieve a Payment Card with specified identifier string.

Retrieve a Payment Instrument

Retrieve a payment instrument by ID.

Retrieve a PayPal Account

Retrieve a PayPal Account with specified identifier string.

Retrieve a plan

Retrieve a plan with specified identifier string.

Retrieve a product

Retrieve a product with specified identifier string.

Retrieve a tag

Retrieve a tag.

Retrieve a ThreeDSecure entry

Retrieve a ThreeDSecure entry with specified identifier string.

Retrieve a Transaction

Retrieve a Transaction with specified identifier string.

Retrieve a transaction Timeline message

Retrieve a timeline message with specified identifier string.

Retrieve an Attachment

Retrieve a Attachment with specified identifier string.

Retrieve an invoice

Retrieve an invoice with specified identifier string.

Retrieve an Invoice Timeline message

Retrieve a invoice message with specified identifier string.

Retrieve an order

Retrieve an order with specified identifier string.

Retrieve an order reactivation

Retrieve an order reactivation with specified identifier string.

Retrieve an Order Timeline message

Retrieve a order message with specified identifier string.

Retrieve an order сancellation

Retrieve an order сancellation with specified identifier string.

Retrieve Custom Fields

Retrieve a schema of Custom Fields for the given resource type.

Retrieve customer timeline custom event type with specified identifier string

Retrieve customer timeline custom event type.

Retrieve customer's upcoming invoices

Retrieve a list of upcoming invoices from the subscriptions which belong to. the given customer. The endpoint is temporary before upcoming invoices get a complete integration.

Retrieve invoice items

Retrieve an invoice items with specified invoice identifier string.

Retrieve subscription order's upcoming invoice

Retrieve an upcoming invoice from the specified subscription order. The endpoint is temporary before upcoming invoices get a complete integration.

Review a KYC document

Mark the KYC document as reviewed. Updates the review time and reviewer. information.

Search merchant data

Search merchant's data to return resources such as customers, invoices, orders, transactions.

Search PEP/Sanctions/Adverse Media lists

Search multiple PEP/Sanctions/Adverse Media lists with first and last name to find any blocklisted identities. Performs a fuzzy search including soundex. Not all fields are guaranteed to be filled.

Set a coupon's expiration time

Set a coupon's expiry time with the specified coupon ID. The expiredTime of a coupon must be greater than its issuedTime. This cannot be performed on expired coupons.

Update a KYC document's documentMatches

Updates a KYC document's documentMatches. Intended to be used for manual overrides.

Validate a digital wallet session

[FramePay](https://docs.rebilly.com/docs/developer-docs/framepay/) is the recommended way to use when validating a digital wallet session.

Void an invoice

Void an invoice with specified identifier string.