AbacatePayInstall

Summary

Create a new billing record in AbacatePay.

Inputs

• products (required) — List of products your customer is paying for
• returnUrl (required) — URL to redirect if the customer clicks "Back"
• completionUrl (required) — URL to redirect when payment is completed
• frequency (required) — Billing frequency type
• methods (required) — Available payment methods
• additionalFields — Additional fields to include in the billing request

Output shape

a single created billing resource

Returns the created billing object, typically including generated ID, status, and payment links. No pagination.

Examples

Example 1: Create a one‑time product billing

Set resource=billing, operation=create; fill Products with description, externalId, name, price, quantity; set Return URL and Completion URL; choose Frequency=ONE_TIME; select Methods=PIX; optionally add Customer ID in Additional Fields.

Example 2: Create a multiple‑payment billing for recurring PIX payments

Same as above but set Frequency=MULTIPLE_PAYMENTS; keep Methods=PIX; provide required product fields.

Example 3: Create a billing with coupons

Add coupon codes in Additional Fields.Coupons; fill other required fields as usual.