LogoLogo
  • Introduction
  • Getting Started
    • Your Zum Rails Account
    • Developer Quickstart
  • Payments
    • Introduction
    • Payment Rails
    • Bank Payments
      • EFT
      • ACH
    • Interac e-Transfer
      • Send & Request
      • Review Transactions
    • Card Payments
      • Visa Direct
      • Credit Card
      • Push-to-debit
  • User Tokenization
    • Zūm Connect
  • Invoices & Subscriptions
    • Overview
    • Products
    • Invoices
    • Subscriptions
  • Data Aggregation
    • Overview
    • Use Cases
    • Supported Institutions
    • Data
    • How it works
    • Testing
  • Insights
    • Overview
    • Income
    • Expenses
    • Insights
  • Brand Customization
    • Brand Customization
  • API Reference
    • Overview
    • Authentication
    • Users
    • Transactions
    • Funding Source
    • Products
    • Product Prices
    • Invoices
    • Subscriptions
    • Aggregation
    • Insights
    • Wallets
    • Operations
      • Transaction Limits
      • Review Transactions
      • Daily Auto-Withdrawal Summary
    • Webhooks
    • Errors
    • Idempotency
    • Country & Region Codes
  • Archived Documentation
Powered by GitBook
On this page
  • Product
  • Manage existing products and prices
  • Price
  • Common Fee
  • Tax
  1. Invoices & Subscriptions

Products

PreviousOverviewNextInvoices

Last updated 7 days ago

Product

Products represent the goods or services you offer to your users. You might also offer versions of your products. Each product has a unique ID which is automatically generated when you create a product. When you create a product in Zūm Rails, you have to provide a name. You can optionally add other attributes, like a description or image.

Because you can have multiple products, you’ll need to specify which product to use when creating Checkout links, Invoices or Subscriptions if you want to sell a specific product to the user.

Manage existing products and prices

You can update product details through the Portal or API. For example, you might change the description of a product, or add new product images to use on the Checkout page.

If you’re no longer selling a product, you can archive both it and the price through the Dashboard by clicking the Archive button, or through the API. We store the archived product and price information indefinitely to maintain records of past invoices/subscriptions/transactions. You can delete products or prices that are currently not being used for invoices/subscriptions.

Learn more about how to create a product and the product lifecycle in the

Learn more about payment links and using Products using Zum Connect .

Price

Prices define how much and how often to charge for products. Prices can either be a one-time or recurring plan. Subscriptions use recurring prices to charge the customer at an interval, such as “monthly.” If you sell the same service at several different subscription intervals, it’s best to create multiple recurring prices for the same product.

Because a product can have multiple prices associated with it, you’ll need to specify which price to use when creating Checkout links, Invoices or Subscriptions if you want to sell a specific product price to the user.

NOTE

At Least one price is necessary to create a product.

Pricing models reflect your business revenue model. We currently offer the below models for pricing:

  • Standard pricing—Charge the same price for each unit.

  • Package pricing—Charge by the package, or group of units, like charging $15.00 CAD for every 5 units. Purchases are rounded up by default, so a customer buying 8 units would pay $30.00 CAD.

Here’s how you can create products/prices:

Common Fee

Common Fees describe the price of fees presented to your users and can be applied to invoices/subscriptions or for checkout links. However, we won’t automatically set them on your behalf unless you specifically set it when creating the common fee.

Tax

Zūm Rails allows you to define any number of tax rates and apply them to invoices, subscriptions, and payments when using Checkout. However, we won’t automatically set them on your behalf unless you specifically set it when creating the tax rate.

Tax rates can either be exclusive or inclusive. An exclusive tax is not included in the invoice subtotal, whereas an inclusive tax is.

The following table illustrates a 13% tax rate modifying the total amount due, depending on whether it’s exclusive or inclusive.

Tax
Subtotal
Tax Due
Total

13% Exclusive

$5.00

$0.65

$5.65 ($5.00 + $0.65)

13% Inclusive

$5.00

$0.65 (already included in the price)

$5.00 ($4.35 + $0.65)

When determining tax amounts, Zūm Rails rounds it to the smallest currency unit (2 decimals) before summing across the entire invoice. You can add multiple tax rates to invoices/subscriptions or for checkout links.

API Reference documentation.
here