Provide purchase data to Rebilly Instruments

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

This topic describes how to pass purchase data to RebillyInstruments.mount(), you must provide purchase data to complete the customer flow. It is mandatory to use one of the following properties that are detailed in this page:

• items property.
• money property.
• invoiceId property.
• transactionId property.
• deposit property.
• payout property.
• jwt property.

To change the purchase data at runtime, use the RebillyInstruments.update() function.

items property

Use this option when a customer has selected multiple items, such as in a shopping cart, or when you have specific plans to offer to a customer.

Each object in the items array object must include a planId and a quantity property. For more information, see Create a product and pricing plan.

Additionally, if Rebilly Instruments has been supplied with a summary, items may include a thumbnail.

Example

RebillyInstruments.mount({
  publishableKey: 'pk_123',
  organizationId: 'org-123',
  websiteId: 'my-website-id',
  items: [
    {
      planId: 'plan-abc',
      quantity: 1,
      thumbnail: 'https://www.example.com/image.png', // this property is optional
    },
  ],
});

money property

Use this option to permit a customer to make a purchase without additional configuration. Directly specify the amount to request from the customer.

The money object must include amount and currency properties.

Example

RebillyInstruments.mount({
  publishableKey: 'pk_123',
  organizationId: 'org-123',
  websiteId: 'my-website-id',
  money: {
    amount: 50,
    currency: 'USD',
  },
});

invoiceId property

Use this option to directly make a payment on a specific invoice.

Example

RebillyInstruments.mount({
  invoiceId: 'an-invoice-id',
  jwt: 'the-customer-jwt',
});

transactionId property

Use this options to directly make a payment towards a specific transaction.

Example

RebillyInstruments.mount({
  transactionId: 'a-transaction-id',
  jwt: 'the-customer-jwt',
});

deposit property

Use this option to allow the customer to set the deposit amount.

• deposit must be accompanied by jwt property.

• deposit must provide the depositRequestId or currency property, all other properties are optional. For more information, see Rebilly Instruments reference.

Example

RebillyInstruments.mount({
  deposit: {
    depositRequestId: 'a-deposit-request-id',
  },
  jwt: 'the-customer-jwt',
});

or

RebillyInstruments.mount({
  deposit: {
    currency: 'USD',
  },
  jwt: 'the-customer-jwt',
});

payout property

Use this option to allow the customer to set the deposit amount.

• payout must be accompanied by jwt property.
• payout must provide the payoutRequestId.

Example

RebillyInstruments.mount({
  payout: {
    payoutRequestId: 'a-payout-request-id',
  },
  jwt: 'the-customer-jwt',
});

jwt property

1. Create a customer.

2. Create a secret API key.

3. From the server, execute the PostAuthenticationToken operation, using the following required parameters:

   • mode: Set as passwordless.
   • customerId: ID of the customer you created that you created in step 1.

4. From the response, use the token value to execute the PostAuthenticationTokenExchange operation. This exchange must occur as closely as possible to when the customer accesses the data.

   • acl: Include a scope with your organizationId, the transactionId or invoiceId, and the following permissions:
     • PostToken
     • PostDigitalWalletValidation
     • StorefrontGetAccount
     • StorefrontPatchAccount
     • StorefrontPostPayment
     • StorefrontGetTransactionCollection
     • StorefrontGetTransaction
     • StorefrontGetPaymentInstrumentCollection
     • StorefrontPostPaymentInstrument
     • StorefrontGetPaymentInstrument
     • StorefrontPatchPaymentInstrument
     • StorefrontPostPaymentInstrumentDeactivation
     • StorefrontGetWebsite
     • StorefrontGetInvoiceCollection
     • StorefrontGetInvoice
     • StorefrontGetProductCollection
     • StorefrontGetProduct
     • StorefrontPostReadyToPay
     • StorefrontPostReadyToPayout
     • StorefrontGetPaymentInstrumentSetup
     • StorefrontPostPaymentInstrumentSetup
     • StorefrontGetDepositRequest
     • StorefrontGetDepositStrategy
     • StorefrontGetPayoutRequest
     • StorefrontGetPayoutRequestCollection
     • StorefrontPatchPayoutRequest
   • customClaims: include the websiteId as well as the transactionId or invoiceId.

5. From the response, use the token value as the JWT for customer authentication.

Example

RebillyInstruments.mount({
  jwt: 'the-customer-jwt',
});