Recurring Payments
Set up standing orders (הוראת קבע) that charge a customer's card automatically on a schedule. Creating a recurring payment returns a hosted page link where the customer enters their card and confirms the mandate.
/grow/recurring-paymentsCreate a recurring payment mandate. Returns a hosted page link where the customer completes card details and confirms.
Body Parameters
| Name | Type | Description | |
|---|---|---|---|
paymentProviderId | number | required | ID of the active payment provider (see Payment Providers). |
sum | number | required | Amount charged on each cycle. |
description | string | required | Description of the recurring charge. |
entityId | number | ID of the client the mandate belongs to. | |
payingCompanyId | number | ID of the company being charged, when different from the authenticated company. | |
paymentNum | number | Number of scheduled charges (2–12). | |
maxPaymentNum | number | Maximum number of charges (2–12). | |
chargeDay | number | Day of the month to charge (1–31). | |
invoiceLicenseNumber | string | Tax ID / license number to place on issued invoices. | |
customFields | object | Arbitrary key/value pairs stored with the mandate. | |
productData | array | Line items to place on documents issued for each charge. | |
catalogNumber | number | Catalog number of the product. | |
quantity | number | Quantity. | |
price | number | Unit price. | |
itemDescription | string | Line item description. |
Request
curl -X POST "https://api.glance.co.il/grow/recurring-payments" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"paymentProviderId": 0,
"sum": 0,
"description": "example_description",
"entityId": 0,
"payingCompanyId": 0,
"paymentNum": 0,
"maxPaymentNum": 0,
"chargeDay": 0,
"invoiceLicenseNumber": "example_invoiceLicenseNumber",
"customFields": {},
"productData": []
}'Response
{
"success": true,
"data": {
"recurringPaymentId": 77,
"visibleId": "3f8b5c2a-1d4e-4a7b-9c6f-2e1a0b8d7c5e"
}
}/grow/recurring-paymentsList recurring payments with optional filtering and pagination.
Query Parameters
| Name | Type | Description | |
|---|---|---|---|
status | string | Filter by status. One of "PENDING", "ACTIVE", "CANCELED". | |
entityId | number | Filter by the client the mandate belongs to. | |
sortOrder | string | Sort by creation date: "asc" or "desc" (default). | |
limit | number | Items per page (default 50). | |
offset | number | Number of items to skip (default 0). |
Request
curl -X GET "https://api.glance.co.il/grow/recurring-payments" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
{
"success": true,
"data": [
{
"id": 77,
"entityId": 1,
"sum": 99,
"paymentNum": 12,
"chargeDay": 1,
"status": "ACTIVE",
"fullName": "John Doe",
"email": "john@example.com",
"description": "Monthly membership",
"cardSuffix": "4242",
"cardBrand": "Visa",
"createdAt": "2026-03-20T14:30:00Z",
"transaction": null
}
],
"pagination": {
"total": 1,
"limit": 50,
"offset": 0,
"hasMore": false
}
}/grow/recurring-payments/:idGet a single recurring payment, including its most recent transaction.
Path Parameters
| Name | Type | Description | |
|---|---|---|---|
id | number | required | Recurring payment ID. |
Request
curl -X GET "https://api.glance.co.il/grow/recurring-payments/:id" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
{
"success": true,
"data": {
"id": 77,
"entityId": 1,
"sum": 99,
"paymentNum": 12,
"chargeDay": 1,
"status": "ACTIVE",
"fullName": "John Doe",
"email": "john@example.com",
"description": "Monthly membership",
"cardSuffix": "4242",
"cardBrand": "Visa",
"asmachta": "0012345",
"createdAt": "2026-03-20T14:30:00Z",
"transaction": {
"id": 6001,
"amount": 99,
"status": "PAID",
"date": "2026-04-01T00:05:00Z"
}
}
}/grow/recurring-payments/:idUpdate an active mandate — amount, schedule, payer details, or status. Requires the mandate to have been confirmed by the customer.
Path Parameters
| Name | Type | Description | |
|---|---|---|---|
id | number | required | Recurring payment ID. |
Body Parameters
| Name | Type | Description | |
|---|---|---|---|
sum | number | New amount per cycle. | |
paymentNum | number | New number of charges (1–48). | |
chargeDay | number | New day of the month to charge (1–31). | |
fullName | string | Payer full name. | |
phone | string | Payer phone number. | |
email | string | Payer email. | |
changeStatus | string | Change the mandate status. One of "ACTIVE" or "CANCELED". | |
updateCard | boolean | If true, prompt the customer to update the card on file. |
Request
curl -X PUT "https://api.glance.co.il/grow/recurring-payments/:id" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sum": 0,
"paymentNum": 0,
"chargeDay": 0,
"fullName": "example_fullName",
"phone": "example_phone",
"email": "example_email",
"changeStatus": "example_changeStatus",
"updateCard": true
}'Response
{
"success": true,
"data": {
"id": 77,
"sum": 120,
"chargeDay": 5,
"status": "ACTIVE"
}
}/grow/recurring-payments/:id/cancelCancel a recurring payment. Sets its status to CANCELED.
Path Parameters
| Name | Type | Description | |
|---|---|---|---|
id | number | required | Recurring payment ID. |
Request
curl -X POST "https://api.glance.co.il/grow/recurring-payments/:id/cancel" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
{
"success": true,
"data": {
"id": 77,
"status": "CANCELED"
}
}/grow/recurring-payments/:id/activateRe-activate a canceled recurring payment. Sets its status to ACTIVE.
Path Parameters
| Name | Type | Description | |
|---|---|---|---|
id | number | required | Recurring payment ID. |
Request
curl -X POST "https://api.glance.co.il/grow/recurring-payments/:id/activate" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
{
"success": true,
"data": {
"id": 77,
"status": "ACTIVE"
}
}/grow/recurring-payments/:idDelete a recurring payment. It is soft-deleted and hidden from lists.
Path Parameters
| Name | Type | Description | |
|---|---|---|---|
id | number | required | Recurring payment ID. |
Request
curl -X DELETE "https://api.glance.co.il/grow/recurring-payments/:id" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
{
"success": true
}