Authorization
Example:
Authorization | Bearer Paste-Your-API-Key-HerePath Parameters
The unique identifier of the membership member to bill.Example:
MBR8X2QKRequest Body
productId may be supplied in the request body OR as a query parameter (see
Query Parameters). At least one location is required.
The unique identifier of the product the member belongs to. Accepted here in the
JSON body, or alternatively as a query parameter.Example:
7c9d2e1f-4a5b-4c6d-8e9f-0a1b2c3d4e5fQuery Parameters
Alternative location for
productId when you prefer not to send a request body.
Use either the body field or this query parameter.Example:?productId=7c9d2e1f-4a5b-4c6d-8e9f-0a1b2c3d4e5fIdempotency (term-based)
Invoices are idempotent per billing term. The endpoint keys on the member’s current billing period: if an unpaid invoice already exists for the current period it is reused and returned instead of creating a duplicate. Calling this endpoint repeatedly within the same billing term therefore returns the same invoice (and the samemembershipBillUrl).
Response
Successful ResponseMain Structure (Root Object)
Status code from the API.
200 on success.Status message that describes the result. Note the singular
message key
(write endpoints use message; read/list endpoints use the plural messages).The created (or reused) membership invoice object for the current billing term.
The unique identifier of the invoice.
The identifier of the underlying transaction associated with the invoice.
The identifier of the customer being billed.
The identifier of the member’s tier.
The amount due for the billing term.
Current status of the invoice (for example
created).Invoice expiration time in ISO 8601 format (UTC).
The membership bill URL the customer can use to pay. Built from the tenant’s shop
subdomain in the shape
https://<tenant>.mayar.shop/pl/<link> — this is not an
api.mayar.id URL.Errors
All errors use the envelope{ "statusCode": <code>, "message": "<reason>" } (singular message).
Error Example 400
The HTTP status code of the error.
A human-readable description of the error.
| Status | message | When |
|---|---|---|
400 | Invalid path parameter | memberId is missing or malformed in the path. |
400 | Invalid request body | productId is missing from both the body and the query, or the request fails validation. |
