mutation runPaymentPlanAuthenticated
Runs a payment plan creating a payment if the payment plan is in an Active status. This will create a payment regardless of schedule, frequency or start date.
Returns PaymentPlan!
Arguments
| Argument | Type | Description |
|---|---|---|
id | ID! |
Example request
curl -X POST 'https://graph.clientloop.com/' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <api-key>' \
-d '{
"query": "mutation RunPaymentPlan($id: ID!) { runPaymentPlan(id: $id) { id orgId contactId amount currency startDate occurrences remainingOccurrences nextRunAt paymentPlanSessionId } }",
"variables": {
"id": "abc123"
}
}'const response = await fetch('https://graph.clientloop.com/', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer <api-key>',
},
body: JSON.stringify({
query: `
mutation RunPaymentPlan($id: ID!) {
runPaymentPlan(id: $id) {
id
orgId
contactId
amount
currency
startDate
occurrences
remainingOccurrences
nextRunAt
paymentPlanSessionId
}
}
`,
variables: {
"id": "abc123"
},
}),
});
const { data, errors } = await response.json();<?php
$body = <<<'JSON'
{
"query": "mutation RunPaymentPlan($id: ID!) { runPaymentPlan(id: $id) { id orgId contactId amount currency startDate occurrences remainingOccurrences nextRunAt paymentPlanSessionId } }",
"variables": {
"id": "abc123"
}
}
JSON;
$ch = curl_init('https://graph.clientloop.com/');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'Authorization: Bearer <api-key>',
],
CURLOPT_POSTFIELDS => $body,
]);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var body = """
{
"query": "mutation RunPaymentPlan($id: ID!) { runPaymentPlan(id: $id) { id orgId contactId amount currency startDate occurrences remainingOccurrences nextRunAt paymentPlanSessionId } }",
"variables": {
"id": "abc123"
}
}
""";
var request = HttpRequest.newBuilder(URI.create("https://graph.clientloop.com/"))
.header("Content-Type", "application/json")
.header("Authorization", "Bearer <api-key>")
.POST(HttpRequest.BodyPublishers.ofString(body))
.build();
var response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());using System.Net.Http;
using System.Text;
var body = """
{
"query": "mutation RunPaymentPlan($id: ID!) { runPaymentPlan(id: $id) { id orgId contactId amount currency startDate occurrences remainingOccurrences nextRunAt paymentPlanSessionId } }",
"variables": {
"id": "abc123"
}
}
""";
using var client = new HttpClient();
using var content = new StringContent(body, Encoding.UTF8, "application/json");
client.DefaultRequestHeaders.Add("Authorization", "Bearer <api-key>");
var response = await client.PostAsync("https://graph.clientloop.com/", content);
var result = await response.Content.ReadAsStringAsync();Types
type PaymentPlan
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier for a payment plan |
orgId | ID! | ID of the organization that this payment plan belongs to |
contactId | ID! | ID of the platform contact associated with this payment plan |
amount | Amount! | Payment amount to be charged on the configured frequency. |
currency | Currency! | Currency of the payment |
startDate | Date! | Start date of the payment plan |
occurrences | Int! | Number of payment occurrences to be run on the configured frequency from the start date |
remainingOccurrences | Int! | Remaining payments on the plan |
nextRunAt | DateTime | Next scheduled payment run |
paymentPlanSessionId | ID | ID of the payment plan session that generated this payment plan |
scalar Amount
A monetary amount with up to two decimal places. Ex. 111.11
scalar Currency
Three letter ISO 4217 currency code. Ex. USD
scalar Date
ISO 8601 formatted date in the format YYYY-MM-DD
scalar DateTime
ISO 8601 formatted date time. Ex. 2023-11-23T14:30:00Z