www.rebilly.com Open in urlscan Pro
44.214.59.241  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Solutions
   
   
   OUR SOLUTIONS
   
   Solve all things payments with a single integration
   
   Solutions overview
   
   PRODUCTS
   
   Payments
   
   Harness the perfect payment orchestration platform and sell anything,
   anywhere
   
   KYC
   
   Verify IDs and monitor identities with powerful built-in AML tools
   
   Billing
   
   Price, deliver and manage subscription billing & invoicing
   
   FEATURES
   
   Risk & Compliance
   
   Reduce PCI compliance scope and fight fraud on a single ultra-secure platform
   
   Reporting & Automation
   
   Leverage data and intelligence to unlock more revenue

 * Pricing
 * Docs
 * About
   
   
   Company
   
   BlogAbout usCustomer storiesCareers
   
   Technology
   
   Gateway integrationsPayment methods

Search/
Get started
Get started
 * Solution Overview

   SOLUTIONS
   
   
   PaymentsKYCBillingRisk & ComplianceReporting & Automation

   ABOUT
   
   
   BlogAbout usCustomer storiesCareersGateway integrationsPayment methods

 * Pricing
 * Docs


All APIs
Introduction
Authentication

Errors
SDKs

Get started
Rate limits
Allowlists

AML

API keys

Application owners

Application users

Balance transactions

Billing portals

Blocklists

Broadcast messages

Checkout forms

Coupons

Credit memos

Credit memos timeline

Custom domains

Custom fields

Customer authentication

Customers

Customers timeline

Data exports

Deposits

Disputes

Email delivery settings

Email messages

Email notifications

External identifiers

Fees

Files

Gateway accounts

Gateway accounts timeline

Histograms

Integrations

Invoices

Invoices timeline

Journal

KYC documents

Lists

Memberships

Metadata

Orders

Orders timeline

Organization data exports

Organizations

Payment instruments

Payment tokens

Plans

Products

Profile

Quotes

Quotes timeline

Reports

Reset password

Risk score

Roles

Rules

Rules timeline

Search

Segments

Service credentials

Shipping rates

Status

Storefront account

Storefront billing portals

Storefront checkout forms

Storefront custom fields

Storefront deposits

Storefront invoices

Storefront KYC documents

Storefront orders

Storefront payment instruments

Storefront plans

Storefront products

Storefront purchases

Storefront quotes

Storefront transactions

Storefront websites

Tags

Tracking

Transactions

Transactions timeline

Usage

Users

Webhooks

Websites



Introduction


ALL APIS (LATEST)




INTRODUCTION

The Rebilly API is built on HTTP and is RESTful. It has predictable resource
URLs and returns HTTP response codes to indicate errors. It also accepts and
returns JSON in the HTTP body. Use your favorite HTTP/REST library in your
programming language when using this API, or use one of the Rebilly SDKs, which
are available in PHP and JavaScript.

Every action in the Rebilly UI is supported by an API which is documented and
available for use, so that you may automate any necessary workflows or
processes. This API reference documentation contains the most commonly
integrated resources.


AUTHENTICATION

This topic describes the different forms of authentication that are available in
the Rebilly API, and how to use them.

Rebilly offers four forms of authentication: secret key, publishable key, JSON
Web Tokens, and public signature key.

 * Secret API key: Use to make requests from the server side. Never share these
   keys. Keep them guarded and secure.
 * Publishable API key: Use in your client-side code to tokenize payment
   information.
 * JWT: Use to make short-life tokens that expire after a set period of time.


MANAGE API KEYS

To create or manage API keys, select one of the following:

 * Use the Rebilly UI: see Manage API keys
 * Use the Rebilly API: see the API key operations.

For more information on API keys, see API keys.


ERRORS

Rebilly follows the error response format proposed in RFC 9457, which is also
known as Problem Details for HTTP APIs. As with any API responses, your client
must be prepared to gracefully handle additional members of the response.


SDKS

Rebilly provides a JavaScript SDK and a PHP SDK to help interact with the
Rebilly API. However, no SDK is required to use the API.

Rebilly also provides FramePay, a client-side iFrame-based solution, to help
create payment tokens while minimizing PCI DSS compliance burdens and maximizing
your customization ability. FramePay interacts with the payment tokens creation
operation.


JAVASCRIPT SDK

For installation and usage instructions, see SDKs. All JavaScript SDK code
examples are included in the API reference documentation.


PHP SDK

For installation and usage instructions, see SDKs. All SDK code examples are
included in the API reference documentation. To use them, you must configure the
$client as follows:

$client = new Rebilly\Client([
    'apiKey' => 'YourApiKeyHere',
    'baseUrl' => 'https://api.rebilly.com',
]);



GET STARTED

The full Rebilly API has over 500 operations. This is likely more than you may
need to implement your use cases. If you would like to implement a particular
use case, contact Rebilly for guidance and feedback on the best API operations
to use for the task.

To integrate Rebilly, and learn about related resources and concepts, see Get
started.


RATE LIMITS

Rebilly enforces rate limits on the API to ensure that no single organization
consumes too many resources. Rate limits are applied to the organization, and
not to the API key. In sandbox environment, rate limits are enforced for non-GET
endpoints and are set at 3000 requests per 10 minutes. You can find the exact
number of consumed requests in the X-RateLimit-Limit and X-RateLimit-Remaining
headers in the response. If the rate limit is exceeded, the API returns a 429
Too Many Requests response and a X-RateLimit-Retry-After header that includes a
UTC timestamp of when the rate limit resets.

Download OpenAPI description
all.json
all.yaml
Overview
URL https://www.rebilly.com/contact/

Rebilly API Support integrations@rebilly.com

License Rebilly

Terms of Service

Languages
curlJavaScriptNode.jsPythonJavaC#
 * PHP
 * Go
 * Ruby
 * R
 * Payload

Servers
Mock server
https://www.rebilly.com/_mock/catalog/all/

Sandbox server
https://api-sandbox.rebilly.com/organizations/{organizationId}/

+Show 1 variable
Live server
https://api.rebilly.com/organizations/{organizationId}/

+Show 1 variable


ALLOWLISTS

Use allowlists to exclude specific customer attribute data from risk score
checks.

Allowlists are lists of data that are excluded from risk score checks.
Allowlists prevent specific data from being added to a blocklist record when a
risk score threshold reached.

Operations
get
/allowlists
post
/allowlists
get
/allowlists/{id}
delete
/allowlists/{id}
+ Show


AML

Use Anti-Money Laundering (AML) operations to screen customers and help prevent
your business from becoming directly or indirectly involved in criminal
activity.

Use AML operations during customer creation, and some transaction processing, to
help determine if a potential customer (lead), or customer, has political or
economic sanctions against them.

AML operations search the following for screening purposes: Politically Exposed
Persons (PEPs) lists, sanction lists, and adverse media lists.

Operations
get
/aml-checks
get
/aml-checks/{id}
post
/aml-checks/{id}/start-review
post
/aml-checks/{id}/stop-review
post
/aml-checks/{id}/review
get
/aml-settings
put
/aml-settingsWebhooks
post
aml-list-possibly-matched
+ Show


API KEYS

Use API keys to identify and authenticate applications and users. Always keep
your API keys private. When creating API keys, you can restrict them to a given
set of permissions. For information on how to create and manage API keys, see
API keys.

Operations
get
/api-keys
post
/api-keys
get
/api-keys/{id}
put
/api-keys/{id}
delete
/api-keys/{id}
+ Show


APPLICATION OWNERS

Use these operations to register applications to the Rebilly Apps Store and
manage application instances. An application owner is a person or organization
that has submitted an app to the Rebilly App Store. For more information, see
Submit an app.

Operations
post
/applications
get
/applications/{id}/instances
get
/applications/{id}/instances/{organizationId}Webhooks
post
application-instance-disabled
post
application-instance-enabled
+ Show


APPLICATION USERS

Use these operations to install or uninstall apps from the Rebilly App Store to
your Rebilly account, and to manage application instances. An application user
is a person or organization that uses an app that is installed from the Rebilly
App Store. For more information, see Install or uninstall an app.

Operations
get
/application-instances/{applicationId}
put
/application-instances/{applicationId}
delete
/application-instances/{applicationId}
get
/application-instances/{applicationId}/configuration
put
/application-instances/{applicationId}/configuration
get
/applications
get
/applications/{id}
+ Show


BALANCE TRANSACTIONS

Use these operations to view and manage balance transactions.

> Important: These operations are experimental and may change.

Operations
get
/balance-transactionsExperimental
get
/balance-transactions/{id}ExperimentalWebhooks
post
balance-transaction-settled
+ Show


BILLING PORTALS

Use these operations to create and manage billing portals. Rebilly hosted
billing portals provide secure, Rebilly hosted pages, where customers can: view
invoices, cancel subscriptions, update payment instruments, and update their
address.

Operations
get
/billing-portals
post
/billing-portals
get
/billing-portals/{id}
put
/billing-portals/{id}
delete
/billing-portals/{id}
+ Show


BLOCKLISTS

Use blocklists to prevent fraud and criminal activity.

Blocklists are lists of customer attribute values that are blocked from buying
from you. For example, if a customer attempts to make a purchase from you with a
credit card that is in a blocklist, the transaction is blocked and is not
processed.

Before a new transaction is processed in Rebilly, blocklists are examined to
check for attributes related to the entity. If a match is detected, the
operation is aborted. A blocklist that expires after a period of time is called
a greylist.

Operations
get
/blocklists
post
/blocklists
get
/blocklists/{id}
put
/blocklists/{id}
delete
/blocklists/{id}
+ Show


BROADCAST MESSAGES

Use broadcast messages to notify customers and leads about upcoming promotions,
service updates, and events. Broadcast messages are emails that are sent to a
specific group of customers, or all customers. For more information, see Create
a broadcast message.

Operations
get
/broadcast-messages
post
/broadcast-messages
get
/broadcast-messages/{id}
delete
/broadcast-messages/{id}
patch
/broadcast-messages/{id}
+ Show


CHECKOUT FORMS

Use these operations to create and manage checkout forms. Rebilly hosted
checkout forms provide secure and compliant checkouts. Checkout forms are
customizable, and use fully responsive design, built-in error messaging,
validation, and expedited checkout for returning customers.

Operations
get
/checkout-forms
post
/checkout-forms
get
/checkout-forms/{id}
put
/checkout-forms/{id}
delete
/checkout-forms/{id}
+ Show


COUPONS

Use coupons to reward customers, generate sales, or to test new pricing
strategies. Coupons enable you to apply different types of discounts to
invoices, subscriptions, and pricing plans.

Redeemed coupons are attached to a customer's account. Depending on the coupon
restrictions, the redeemed coupons are then applied from the customer's account
to subsequent invoices or subscriptions. Redeemed coupons can only be applied to
invoices of the same currency.

Once a coupon is redeemed it cannot be modified. You may deactivate a coupon or
create a new coupon, but you cannot reuse the same coupon code. If you have a
use case where you must reuse the same code, contact Rebilly.

Operations
get
/coupons-redemptions
post
/coupons-redemptions
get
/coupons-redemptions/{id}
post
/coupons-redemptions/{id}/cancel
get
/coupons
post
/coupons
get
/coupons/{id}
put
/coupons/{id}Show 9 more...
+ Show


CREDIT MEMOS

Use credit memos to provide a customer with store credit. A common use case for
using a credit memo is to provide a customer with store credit, rather than a
refund, if the customer pays more than they owe or returns a product. For
information on the credit memo resource, see Resources.

Operations
get
/credit-memos
post
/credit-memos
get
/credit-memos/{id}
put
/credit-memos/{id}
patch
/credit-memos/{id}
post
/credit-memos/{id}/voidWebhooks
post
credit-memo-applied
post
credit-memo-createdShow 3 more...
+ Show


CREDIT MEMOS TIMELINE

Use credit memo timelines to maintain an audit trail of changes and activity for
each credit memo. Credit memos are a means of providing a customer with store
credit.

Operations
get
/credit-memos/{id}/timeline
post
/credit-memos/{id}/timeline
get
/credit-memos/{id}/timeline/{messageId}
delete
/credit-memos/{id}/timeline/{messageId}
+ Show


CUSTOM DOMAINS

Use custom domains to configure and use your own domain for forms and billing
portals, instead of the default Rebilly domain: portal.secure-payments.app. For
more information, see Configure a custom domain.

Operations
get
/custom-domains
post
/custom-domains
get
/custom-domains/{domain}
delete
/custom-domains/{domain}
+ Show


CUSTOM FIELDS

Use custom fields to extend a resource scheme to include custom data that is not
provided as a common field. Depending on the resource on which the custom field
is added, it may be available in the Rebilly UI.

Example: A custom field called preferredCommunicationChannel is added to the
customer resource. It has two allowed values, which are 'email' and 'phone'.

{
  "customFields": {
      "preferredCommunicationChannel": "email"
  }
}


For detailed information on Rebilly resources, see Resources.

Operations
get
/custom-fields/{resource}
get
/custom-fields/{resource}/{name}
put
/custom-fields/{resource}/{name}
+ Show


CUSTOMER AUTHENTICATION

Use these operations to validate the identity of users and manage authentication
credentials.

Operations
get
/authentication-options
put
/authentication-options
get
/authentication-tokens
post
/authentication-tokens
get
/authentication-tokens/{token}
delete
/authentication-tokens/{token}
post
/authentication-tokens/{token}/exchange
get
/credentialsShow 8 more...
+ Show


CUSTOMERS

Use these operations to manage customers. A customer is an entity that purchases
goods or services from you (a merchant), and is the payee in any transaction
that is credited to you. Customers are associated with payment instruments,
subscriptions, invoices, and other related resources.

In other systems, customers may be referred to as accounts, clients, members,
patrons, or players. For information on the customer resource, see Resources.

Operations
get
/customers
post
/customers
get
/customers/{id}
put
/customers/{id}
delete
/customers/{id}
get
/customers/{id}/lead-source
put
/customers/{id}/lead-source
delete
/customers/{id}/lead-sourceShow 10 more...
+ Show


CUSTOMERS TIMELINE

Use customer timelines to maintain an audit trail of changes and activity for
each customer.

Operations
get
/customer-timeline-custom-events
post
/customer-timeline-custom-events
get
/customer-timeline-custom-events/{id}
get
/customers/{id}/timeline
post
/customers/{id}/timeline
get
/customers/{id}/timeline/{messageId}
delete
/customers/{id}/timeline/{messageId}
get
/customers/{id}/edd-timelineShow 3 more...
+ Show


DATA EXPORTS

Use data export operations to manage the export of resource data, such as:
transactions, customers, subscriptions, invoices, invoice item data, or revenue
audit. Common data export use cases are: accounting, data analysis, reporting,
or importing into other databases.

For detailed information on Rebilly resources, see Resources.

For information on how manage reconciliation, see Transaction reconciliation.

Operations
post
/experimental/data-exports
get
/experimental/data-exports
get
/experimental/data-exports/{id}
put
/experimental/data-exports/{id}
delete
/experimental/data-exports/{id}Webhooks
post
data-export-completed
+ Show


DEPOSITS

Create and manage deposit requests and manage strategies that determine the
deposit amounts to display on the page. Rebilly hosted deposit form provides a
secure and compliant way to deposit funds. Deposit forms are customizable, and
use fully responsive design, built-in error messaging and validation.

> Important: These operations are experimental and may change.

Operations
post
/deposit-requestsExperimental
get
/deposit-requestsExperimental
get
/deposit-requests/{id}Experimental
post
/deposit-strategiesExperimental
get
/deposit-strategiesExperimental
get
/deposit-strategies/{id}Experimental
put
/deposit-strategies/{id}Experimental
delete
/deposit-strategies/{id}ExperimentalShow 5 more...
+ Show


DISPUTES

Use these operations to manage disputes. A dispute occurs when a customer
contests a charge to their account. The dispute and related information is made
available to the merchant by the bank or credit card company. The merchant then
has the option to represent the charge and win the case. This process is called
dispute resolution. If the merchant is unable to represent the charge, the card
issuer typically reverses the sale and adds fees on top of the charge. This
process is called a chargeback.

Operations
get
/disputes
post
/disputes
get
/disputes/{id}
put
/disputes/{id}Webhooks
post
dispute-created
post
dispute-modified
+ Show


EMAIL DELIVERY SETTINGS

Use email delivery settings to configure from which email address notifications
and broadcast message are sent. In Rebilly, this email address is referred to as
a "From address". Supported email service providers are: SMTP, Mailgun,
SendGrid, AWS SES, Postmark, and Rebilly.

Operations
put
/email-delivery-setting-verifications/{token}
get
/email-delivery-settings
post
/email-delivery-settings
get
/email-delivery-settings/{id}
delete
/email-delivery-settings/{id}
patch
/email-delivery-settings/{id}
post
/email-delivery-settings/{id}/resend-email-verification
+ Show


EMAIL MESSAGES

Use email messages to email customers directly.

Operations
get
/email-messages
post
/email-messages
get
/email-messages/{id}
delete
/email-messages/{id}
patch
/email-messages/{id}
+ Show


EMAIL NOTIFICATIONS

Use email notifications to keep customers informed on events, and to inform them
of events that may require action on their end. Email notifications are targeted
email messages that can be plain text or HTML.

Email notifications can also be used to notify teammates about new customers,
blocklist matches, risk score changes, and more. For more information, see Email
notifications.

Operations
get
/email-notifications
get
/send-through-attribution/{eventType}
+ Show


EXTERNAL IDENTIFIERS

Use external identifier operations to associate entities such as customers,
invoices, transactions, journal accounts, journal entries, and more with
external services.

To use external identifiers, you must use an active service credential.

Operations
get
/external-identifiers
get
/{resource}/{resourceId}/external-identifiers/{service}
post
/{resource}/{resourceId}/external-identifiers/{service}
put
/{resource}/{resourceId}/external-identifiers/{service}
delete
/{resource}/{resourceId}/external-identifiers/{service}
get
/external-services-settings
put
/external-services-settings
+ Show


FEES

Use fees to reconcile transactions with applicable fees and discount rates. Fees
are not applied directly to transaction amounts, they do not modify the
transaction amount. Fees help to describe each part of the transaction amount.

> Important: These operations are experimental and may change.

Operations
get
/feesExperimental
post
/feesExperimental
get
/fees/{id}Experimental
put
/fees/{id}Experimental
patch
/fees/{id}Experimental
delete
/fees/{id}Experimental
+ Show


FILES

Use the file entity to store files and related metadata. Files can be sorted by
size, MIME-type, user-defined tags, and description.

The following methods are available to upload files: multipart/form-data encoded
form, RAW POST — by sending the file contents as the POST body, and fetching
from URL — by providing the file URL using the 'url' parameter.

Use the attachments entity to link a file to one or multiple objects, such as:
customer, dispute, transaction, order, plan, product, invoice, or timeline
comment. Attachments enable you to quickly find and use files related to
specific entities.

Operations
get
/attachments
post
/attachments
get
/attachments/{id}
put
/attachments/{id}
delete
/attachments/{id}
get
/files
post
/files
get
/files/{id}Show 3 more...
+ Show


GATEWAY ACCOUNTS

Use these operations to manage payment gateway accounts. A payment gateway is a
service which enables merchants to receive payments from their customers to
their merchant account. A merchant account is a bank account that enables
businesses to receive payments. Use payment gateway accounts to connect payment
requests to third party networks and platforms.

Operations
get
/gateway-accounts
post
/gateway-accounts
get
/gateway-accounts/{id}
put
/gateway-accounts/{id}
patch
/gateway-accounts/{id}
delete
/gateway-accounts/{id}
post
/gateway-accounts/{id}/close
post
/gateway-accounts/{id}/disableShow 17 more...
+ Show


GATEWAY ACCOUNTS TIMELINE

Use gateway account timelines to maintain an audit trail of changes and activity
for each gateway account.

Operations
get
/gateway-accounts/{id}/timeline
post
/gateway-accounts/{id}/timeline
get
/gateway-accounts/{id}/timeline/{messageId}
delete
/gateway-accounts/{id}/timeline/{messageId}
+ Show


HISTOGRAMS

Use histograms operations to generate transaction histogram reports with cohorts
and periods. For information on the invoice resource, see Resources.

Operations
get
/experimental/histograms/transactionsExperimental
+ Show


INTEGRATIONS

Use these operations to manage third-party apps that are integrated to your
Rebilly account. For more information on third-party apps, and how to integrate
them, see App store.

Operations
get
/integrations
get
/integrations/{label}
+ Show


INVOICES

Use invoices to bill for the goods or services that you provide. If your invoice
includes subscription items, it also includes the corresponding service periods
and prices.

Operations
get
/invoices
post
/invoices
get
/invoices/{id}
put
/invoices/{id}
get
/invoices/{id}/items
post
/invoices/{id}/items
get
/invoices/{id}/items/{itemId}
put
/invoices/{id}/items/{itemId}Show 23 more...
+ Show


INVOICES TIMELINE

Use invoice timelines to maintain an audit trail of changes and activity for
each invoice.

Operations
get
/invoices/{id}/timeline
post
/invoices/{id}/timeline
get
/invoices/{id}/timeline/{messageId}
delete
/invoices/{id}/timeline/{messageId}
+ Show


JOURNAL

Use journal accounts, entries and records to track and recognize revenue.

Operations
get
/journal-accounts
post
/journal-accounts
get
/journal-accounts/{id}
put
/journal-accounts/{id}
get
/journal-entries
post
/journal-entries
get
/journal-entries/{id}
put
/journal-entries/{id}Show 5 more...
+ Show


KYC DOCUMENTS

Use Know Your Customer (KYC) documents to verify your customers identity. The
KYC document operations generate a signed link to the Rebilly KYC document
gatherer.

Document types:

 * identity-proof: Validates a customer's identity.
 * address-proof: Validates a customer's address.
 * purchase-proof: Validates a customer's purchase.
 * funds-proof: Validates that a customer has funds.
 * credit-file-proof: Verifies that there is an existing credit file with two
   sources that match the customer's name, DOB, and address.

Rebilly parses and analyzes the documents and accepts or rejects them according
to a configurable scoring algorithm. When all document types in a KYC request
are accepted, the status is fulfilled, and the KYC request fulfilled webhook is
sent.

Operations
post
/kyc-requests
get
/kyc-requests
get
/kyc-requests/{id}
patch
/kyc-requests/{id}
delete
/kyc-requests/{id}
get
/kyc-documents
post
/kyc-documents
get
/kyc-documents/{id}Show 18 more...
+ Show


LISTS

Use lists to create and maintain sets of values that may be referenced in rule
conditions. Commonly used lists contain values related to conditions that target
specific properties such as: customers, transactions, or BINs.

You may grant list edit permissions to members of your team without enabling
them to edit rules. This may be useful if your workflow involves frequent
updates to value sets that are used in rule or bind conditions. List order may
not be maintained and duplicates may be removed.

For more information, see Value lists.

Operations
get
/lists
post
/lists
get
/lists/{id}
put
/lists/{id}
delete
/lists/{id}
get
/lists/{id}/{version}
+ Show


MEMBERSHIPS

Use these operations to manage user membership within your organizations.
Membership describes the relationship between organizations and users. For
example, one user could be a member of more than one organization.

Operations
get
/memberships
get
/memberships/{organizationId}/{userId}
put
/memberships/{organizationId}/{userId}
delete
/memberships/{organizationId}/{userId}
+ Show


METADATA

Use these operations to retrieve and manage metadata. Metadata is structured
information on other data.

Operations
get
/payment-methods
get
/payment-methods/{apiName}
get
/payment-gateways-metadata
get
/payment-gateways-metadata/{apiName}
+ Show


ORDERS

Use these operations to manage customer orders. An order is a customer's request
to purchase items. It can contain subscription and one-time sale items. When an
order contains one or more subscription items, it is a subscription order.

An order generates an invoice. A subscription order generates an invoice for
each service period. For more information, see Orders.

Operations
get
/subscriptions
post
/subscriptions
get
/subscriptions/{id}
put
/subscriptions/{id}
delete
/subscriptions/{id}
post
/subscriptions/{id}/void
post
/subscriptions/{id}/change-items
patch
/subscriptions/{id}/items/{itemId}ExperimentalShow 47 more...
+ Show


ORDERS TIMELINE

Use order timelines to maintain an audit trail of changes and activity for each
order.

Operations
get
/subscriptions/{id}/timeline
post
/subscriptions/{id}/timeline
get
/subscriptions/{id}/timeline/{messageId}
delete
/subscriptions/{id}/timeline/{messageId}
+ Show


ORGANIZATION DATA EXPORTS

Use organization data exports to export your organization data which you may
want to do as a business continuity practice. These may also be used to to
export data if you decide to migrate to a different payments solution.

Operations
get
/organization-exports
post
/organization-exports
get
/organization-exports/{id}
+ Show


ORGANIZATIONS

Use these operations to manage your organizations in Rebilly. An organization is
an entity that represents you, or your company, as a merchant. You can have
multiple organizations. For more information, see My organizations and websites.

Note: No data, including organizations, is shared between the live and sandbox
environments.

Operations
get
/organizations
post
/organizations
get
/organizations/{id}
patch
/organizations/{id}
+ Show


PAYMENT INSTRUMENTS

Use these operations to manage payment instruments. Payment instrument is a term
which describes any means of making a digital payment, such as: credit cards,
debit cards, direct debits, payment service providers, and digital wallets.

For more information on payment instruments, see Payment instruments.

Operations
get
/payment-instruments
post
/payment-instruments
get
/payment-instruments/{id}
patch
/payment-instruments/{id}
post
/payment-instruments/{id}/deactivation
post
/payment-instruments/{id}/name-inquiry
get
/payment-cards-bank-namesWebhooks
post
payment-card-createdShow 3 more...
+ Show


PAYMENT TOKENS

Use payment tokens to reduce the scope of PCI DSS compliance.

A payment token can be made using a different authentication scheme (public key
authentication), which enables you to create a payment token directly from the
browser. This bypasses the need to send sensitive cardholder info to your
servers. We recommend using this with the FramePay library, which helps you
integrate a form into this API resource and create payment tokens.

Operations
post
/tokens
get
/tokens
get
/tokens/{token}
post
/digital-wallets/validation
+ Show


PLANS

Use pricing plans to describe how the customer must pay for products.

Rebilly provides the following plan types:

 * Trial only: Use this plan to create and offer a free or discounted trial
   period for your product. For example, a free 2 week trial of an internet
   service. After the trial, the customer can choose to sign up for a paid
   subscription, or stop using the service.
 * Recurring: Use this plan to create and offer a subscription for your product.
   For example, a monthly subscription to an internet service that is charged at
   20 USD per month.
 * One time sale: Use this plan to create and offer a one-off sale for your
   products. For example, a one time purchase of two bags of coffee.

For information on the plans resource, see Plans.

For information on plan pricing, see Pricing formulas.

Operations
get
/plans
post
/plans
get
/plans/{id}
put
/plans/{id}
delete
/plans/{id}
+ Show


PRODUCTS

Use products to describe the goods and services that your business sells. A
product also describes sales items on invoices and receipts. Product pricing is
defined in plans. A product may have one or many plans.

For information on the product resource, see Product.

Operations
get
/products
post
/products
get
/products/{id}
put
/products/{id}
delete
/products/{id}
+ Show


PROFILE

Use these operations to manage user profiles. A profile represents the person
that is signed in to Rebilly.

Operations
post
/permissions-emulation
delete
/permissions-emulation
get
/profile
put
/profile
get
/profile/mfa
post
/profile/mfa
delete
/profile/mfa
+ Show


QUOTES

Use quote operations to create and manage quotations. Quotations describe the
cost of goods or services to potential customers before they commit to a
purchase. A quote contains an initial invoice preview that can be accepted to
become an order.

A quote can contain subscription and one-time sale items. When a quote contains
one or more subscription items, it is a subscription order quote.

Operations
get
/quotesExperimental
post
/quotesExperimental
get
/quotes/{id}Experimental
put
/quotes/{id}Experimental
patch
/quotes/{id}Experimental
post
/quotes/{id}/acceptExperimental
post
/quotes/{id}/cancelExperimental
post
/quotes/{id}/issueExperimentalShow 10 more...
+ Show


QUOTES TIMELINE

Use quote timelines to maintain an audit trail of changes and activity for each
quote.

Operations
get
/quotes/{id}/timelineExperimental
post
/quotes/{id}/timelineExperimental
get
/quotes/{id}/timeline/{messageId}Experimental
delete
/quotes/{id}/timeline/{messageId}Experimental
+ Show


REPORTS

Use reports operations to retrieve summary information about your customers,
subscriptions, transactions, and more.

Operations
get
/experimental/reports/api-log-summaryExperimental
get
/experimental/reports/cumulative-subscriptionsExperimental
get
/experimental/reports/dashboardExperimental
get
/experimental/reports/dcc-markupExperimental
get
/experimental/reports/declined-transactionsExperimental
get
/experimental/reports/disputesExperimental
get
/experimental/reports/events-triggeredExperimental
get
/experimental/reports/events-triggered/{eventType}/rulesExperimentalShow 17
more...
+ Show


RESET PASSWORD

Use these operations to manage password resets. When a password reset is
requested, an email with a token is sent. In the email the user must press a
reset link, and then create a new password.

Operations
post
/forgot-password
+ Show


RISK SCORE

Use risk score operations to configure blocklists based on transaction risk
factors.

Operations
get
/risk-score-rules
put
/risk-score-rules
get
/risk-score-rules/blocklists
put
/risk-score-rules/blocklists
get
/risk-score-simulation-jobs
post
/risk-score-simulation-jobs
get
/risk-score-simulation-jobs/{id}
post
/risk-score-simulation-jobs/{id}/stopShow 1 more...
+ Show


ROLES

Use these operations to manage user roles within your team or organization.
Roles are an implementation of the general hierarchical (Role Based Access
Control) RBAC. A senior role inherits all of its juniors' Access Control Lists
(ACLs) and its own ACL. Junior roles are not influenced by the senior role.

Operations
get
/roles
post
/roles
get
/roles/{id}
put
/roles/{id}
delete
/roles/{id}
+ Show


RULES

Use rules to automate. In the Rebilly rules engine, an action is an operation
that executes when an event occurs. Action and event conditions are defined in
rules. Rulesets are collections of rules that are associated with an event. The
order in which the rules are placed within a ruleset specifies the execution
order.

For a list of events and related actions, see Events.

Operations
get
/events
get
/events/{eventType}
get
/events/{eventType}/rules
put
/events/{eventType}/rules
get
/events/{eventType}/rules/history
get
/events/{eventType}/rules/history/{version}
get
/events/{eventType}/rules/versions/{version}
get
/events/{eventType}/rules/draftsShow 5 more...
+ Show


RULES TIMELINE

Use rule timelines to maintain an audit trail of changes and activity for each
rule.

Operations
get
/events/{eventType}/timeline
post
/events/{eventType}/timeline
get
/events/{eventType}/timeline/{messageId}
delete
/events/{eventType}/timeline/{messageId}
+ Show


SEARCH

Use search operations to search data on customers, invoices, orders,
transactions and more.

Operations
get
/search
+ Show


SEGMENTS

Use these operations to manage UI segments. A segment is a filtered view of a
data set that can be shared with other users. For example, you may create a
transactions segment that displays specific columns that are filtered and sorted
based on certain criteria, and share it with others in your organization.

Operations
get
/grid-segments
post
/grid-segments
get
/grid-segments/{id}
put
/grid-segments/{id}
delete
/grid-segments/{id}
+ Show


SERVICE CREDENTIALS

Use these operations to get, create, and manage credentials for third-party
services.

Operations
get
/service-credentials/{type}
post
/service-credentials/{type}
get
/service-credentials/{type}/{id}
patch
/service-credentials/{type}/{id}
get
/service-credentials/{type}/{id}/items
+ Show


SHIPPING RATES

Use these operations to manage shipping rates. A shipping rate contains a filter
and a pricing for a specific shipping destination.

Operations
get
/shipping-rates
post
/shipping-rates
get
/shipping-rates/{id}
put
/shipping-rates/{id}
delete
/shipping-rates/{id}
+ Show


STATUS

Use this operation to check the status of the Rebilly API. No authentication is
required.

Operations
get
/status
+ Show


STOREFRONT ACCOUNT

Use these operations to manage Storefront accounts. A Storefront account is an
account that the customer is subscribed to in order to use the Rebilly product.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token.

Storefront operations are intended to be used directly from an untrusted
browser.

Operations
get
/storefront/account
patch
/storefront/account
post
/storefront/account/forgot-password
patch
/storefront/account/password
post
/storefront/account/resend-verification
post
/storefront/account/reset-password/{token}
post
/storefront/account/verification/{token}
post
/storefront/loginShow 2 more...
+ Show


STOREFRONT BILLING PORTALS

Use these operations to access Storefront billing portals.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/billing-portals/{slug}
+ Show


STOREFRONT CHECKOUT FORMS

Use these operations to access Storefront checkout forms.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/checkout-forms/{id}
+ Show


STOREFRONT CUSTOM FIELDS

Use these operations to access Storefront custom fields.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/custom-fields/{resource}
+ Show


STOREFRONT DEPOSITS

Use these operations to access Storefront deposits.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/deposit-strategies/{id}Experimental
get
/storefront/deposit-requests/{id}Experimental
post
/storefront/depositExperimental
+ Show


STOREFRONT INVOICES

Use these operations to access Storefront invoices.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/invoices
get
/storefront/invoices/{id}
patch
/storefront/invoices/{id}
+ Show


STOREFRONT KYC DOCUMENTS

Use these operations to access Storefront KYC documents.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/kyc-documents
post
/storefront/kyc-documents
get
/storefront/kyc-documents/{id}
patch
/storefront/kyc-documents/{id}
get
/storefront/kyc-requests/{id}
post
/storefront/kyc-liveness-sessions
get
/storefront/kyc-liveness-sessions/{id}
post
/storefront/kyc-liveness-sessions/{id}/finish
+ Show


STOREFRONT ORDERS

Use these operations to access Storefront orders.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/orders/{id}/upcoming-invoice
get
/storefront/orders
get
/storefront/orders/{id}
patch
/storefront/orders/{id}
post
/storefront/orders/{id}/cancellation
post
/storefront/orders/{id}/pause
post
/storefront/subscriptions/{id}/change-itemsExperimental
post
/storefront/subscription-reactivationsExperimentalShow 1 more...
+ Show


STOREFRONT PAYMENT INSTRUMENTS

Use these operations to access Storefront payment instruments.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/payment-instruments
post
/storefront/payment-instruments
get
/storefront/payment-instruments/{id}
patch
/storefront/payment-instruments/{id}
post
/storefront/payment-instruments/{id}/deactivation
get
/storefront/payment-instruments/{id}/setup
post
/storefront/payment-instruments/{id}/setup
+ Show


STOREFRONT PLANS

Use these operations to access Storefront plans.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/plans
get
/storefront/plans/{id}
+ Show


STOREFRONT PRODUCTS

Use these operations to access Storefront products.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/products
get
/storefront/products/{id}
+ Show


STOREFRONT PURCHASES

Use these operations to manage Storefront purchases. Purchases are transactions
that have been executed related to the purchase of goods or services.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
post
/storefront/payment
post
/storefront/purchase
post
/storefront/preview-purchaseExperimental
post
/storefront/ready-to-pay
post
/storefront/ready-to-payout
+ Show


STOREFRONT QUOTES

Use these operations to access Storefront quotes.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/quotes/{id}Experimental
post
/storefront/quotes/{id}/acceptExperimental
post
/storefront/quotes/{id}/rejectExperimental
+ Show


STOREFRONT TRANSACTIONS

Use these operations to access Storefront transactions.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/payout-requests
get
/storefront/payout-requests/{id}
patch
/storefront/payout-requests/{id}
get
/storefront/transactions
get
/storefront/transactions/{id}
post
/storefront/transactions/{id}/{token}/continue
post
/storefront/transactions/{id}/{token}/bypass
+ Show


STOREFRONT WEBSITES

Use these operations to access Storefront websites.

Storefront operations interact directly with the customer, and provide the
customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited
permissions. For more information, see Create a session with username and
password and Exchange an authentication token. Storefront operations are
intended to be used directly from an untrusted browser.

Operations
get
/storefront/websites/{id}
+ Show


TAGS

Use tags to organize and categorize customers or KYC documents based on
keywords.

Operations
get
/tags
post
/tags
get
/tags/{tag}
patch
/tags/{tag}
delete
/tags/{tag}
post
/tags/{tag}/customers
delete
/tags/{tag}/customers
post
/tags/{tag}/customers/{customerId}Show 14 more...
+ Show


TRACKING

Use tracking when debugging and auditing issues. Tracking is a layer for
accessing all activity such as: API requests, subscriptions, webhooks, events,
and more.

Operations
get
/tracking/api
get
/tracking/api/{id}
get
/tracking/taxes
get
/tracking/taxes/{id}
get
/tracking/lists
get
/tracking/webhooks
get
/tracking/webhooks/{id}
post
/tracking/webhooks/{id}/resend
+ Show


TRANSACTIONS

Use these operations to:

 * set up payment instruments for payments
 * authorize and hold funds
 * capture funds
 * make payments
 * make payouts
 * refund transactions.

Operations
post
/ready-to-pay
post
/transactions
get
/transactions
get
/transactions/{id}
patch
/transactions/{id}
post
/payouts
post
/transactions/{id}/query
post
/transactions/{id}/updateShow 23 more...
+ Show


TRANSACTIONS TIMELINE

Use transaction timelines to maintain an audit trail of changes and activity for
each transaction.

Operations
get
/transactions/{id}/timeline
post
/transactions/{id}/timeline
get
/transactions/{id}/timeline/{messageId}
delete
/transactions/{id}/timeline/{messageId}
+ Show


USAGE

Use these operations to manage the product usage of a subscription item for
metered billing purposes.

Use metered billing when product quantity is unknown to the customer at the
moment of creating a subscription. Metered billing is based on reported usage
records. Every reported usage updates the quantity of an upcoming invoice item
for a specified subscription and a plan. To create a metered billing plan, see
Plans.

Operations
get
/usages
post
/usages
get
/usages/{id}
put
/usages/{id}
delete
/usages/{id}
+ Show


USERS

Use these operations to manage users. A user is a person who can login to
Rebilly, and take actions based on their granted permissions.

Operations
get
/users
post
/users
get
/users/{id}
put
/users/{id}
get
/users/{id}/mfa
+ Show


WEBHOOKS

Use these operations to manage webhooks. Webhooks notify your systems in
real-time when certain events occur. For example, when a new transaction occurs
or a new subscription is created. Webhooks enable you to collect information
about events. Rebilly can send this information by HTTP POST request to a
defined URL of your choice.

Operations
post
/previews/webhooks
get
/webhooks
post
/webhooks
get
/webhooks/{id}
put
/webhooks/{id}
+ Show


WEBSITES

Use these operations to manage websites. A website is where your organization
obtains a customer. It is also the processor account and billing descriptor used
for payment transactions. You can create multiple websites.

Websites are related to each invoice and each payment gateway account. This
enables you to associate gateway accounts with multiple websites, or make them
exclusive to particular websites. For more information, see My organizations and
websites.

Operations
get
/websites
post
/websites
get
/websites/{id}
put
/websites/{id}
delete
/websites/{id}
+ Show



START PERFECTING YOUR PAYMENTS TODAY

Request a demoTry Rebilly
Solutions
 * Solutions overview
 * Payments
 * KYC
 * Billing
 * Risk & Compliance
 * Reporting & Automation
 * Log in
 * Try it free

Resources
 * FAQs
 * Support
 * Docs
 * API reference
 * Gateway integrations
 * Payment methods
 * Customer stories
 * Status
 * Blog

Company
 * About
 * Careers
 * Privacy notice
 * Terms of use
 * Cookie notice
 * API license
 * PCI compliance
 * GDPR FAQ
 * FAQ

Contact
 * Get a demo
 * +1 (512) 710-1640
 * Contact sales & Support
 * 

Copyright © Rebilly 2013-2024. All rights reserved.