Change the current user's billing plan

curl --request PUT \
  --url https://api.leadping.ai/users/change-billing-plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.leadping.ai/users/change-billing-plan"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/users/change-billing-plan");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

HttpResponse<String> response = Unirest.put("https://api.leadping.ai/users/change-billing-plan")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.leadping.ai/users/change-billing-plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/users/change-billing-plan"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/users/change-billing-plan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "email": "jsmith@example.com",
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "timeZoneId": "<string>",
  "billingPlan": "Annual",
  "subscriptionStatus": "Pending",
  "billingState": {
    "hasStripeCustomer": true,
    "hasPaymentMethod": true,
    "phoneNumberQuantity": 123,
    "organizationMemberQuantity": 123,
    "organizationMemberAssignedQuantity": 123,
    "pendingBillingPlan": "Annual",
    "billingPlanChangeEffectiveAt": "2023-11-07T05:31:56Z",
    "planRenewalAt": "2023-11-07T05:31:56Z",
    "planPeriodStartAt": "2023-11-07T05:31:56Z",
    "cancelAt": "2023-11-07T05:31:56Z",
    "dunning": {
      "stage": "<string>",
      "paymentFailedAt": "2023-11-07T05:31:56Z",
      "lastFailedInvoiceStatus": "<string>",
      "retryAttemptCount": 123,
      "nextRetryAt": "2023-11-07T05:31:56Z",
      "gracePeriodEndsAt": "2023-11-07T05:31:56Z",
      "outboundRestrictedAt": "2023-11-07T05:31:56Z",
      "outboundSuspendedAt": "2023-11-07T05:31:56Z",
      "finalCancellationAt": "2023-11-07T05:31:56Z",
      "lastUpdatedAt": "2023-11-07T05:31:56Z"
    },
    "lastSubscriptionEventAt": "2023-11-07T05:31:56Z",
    "lastPaymentMethodEventAt": "2023-11-07T05:31:56Z"
  },
  "roles": [
    "<string>"
  ],
  "identities": [
    {
      "issuer": "<string>",
      "issuerAssignedId": "<string>",
      "signInType": "<string>"
    }
  ],
  "currentOrganization": {
    "id": "<string>",
    "name": "<string>"
  },
  "compliance": {
    "acceptedTerms": true,
    "acceptedToSubscription": true,
    "acceptedSms": true,
    "acceptedBaa": true,
    "acceptedEmail": true,
    "trustedFormCertificates": [
      {
        "id": "<string>",
        "url": "<string>",
        "source": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "notificationPreferences": {
    "smsConsentOptedIn": true,
    "smsConsentUpdatedAt": "2023-11-07T05:31:56Z",
    "smsConsentTrustedFormCertificate": {
      "id": "<string>",
      "url": "<string>",
      "source": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "paymentFailedEnabled": true,
    "paymentFailedSmsEnabled": true,
    "lowWalletBalanceEnabled": true,
    "lowWalletBalanceEmailEnabled": true,
    "lowWalletBalanceSmsEnabled": true,
    "tenDlcStatusEnabled": true,
    "newLeadEnabled": true,
    "newLeadEmailEnabled": true,
    "newLeadSmsEnabled": true,
    "missedCallEnabled": true,
    "missedCallEmailEnabled": true,
    "missedCallSmsEnabled": true,
    "unreadSmsEnabled": true,
    "unreadSmsEmailEnabled": true,
    "unreadSmsSmsEnabled": true,
    "automationFailedEnabled": true,
    "automationFailedEmailEnabled": true,
    "automationFailedSmsEnabled": true,
    "billingEmailEnabled": true,
    "billingSmsEnabled": true,
    "subscriptionRenewingEnabled": true,
    "subscriptionRenewingEmailEnabled": true,
    "subscriptionRenewingSmsEnabled": true,
    "usageLimitHitEnabled": true
  },
  "mobileDevicePreferences": [
    {
      "device": {
        "id": "<string>",
        "name": "<string>"
      },
      "inboundPhoneCallsEnabled": true,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "lastLoggedInAt": "2023-11-07T05:31:56Z",
  "personalDataDeletionRequestedAt": "2023-11-07T05:31:56Z",
  "personalDataDeletedAt": "2023-11-07T05:31:56Z",
  "personalDataDeletionStatus": "<string>",
  "personalDataDeletionReason": "<string>",
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

PUT

users

change-billing-plan

Change the current user's billing plan

curl --request PUT \
  --url https://api.leadping.ai/users/change-billing-plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.leadping.ai/users/change-billing-plan"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/users/change-billing-plan");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

HttpResponse<String> response = Unirest.put("https://api.leadping.ai/users/change-billing-plan")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.leadping.ai/users/change-billing-plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/users/change-billing-plan"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/users/change-billing-plan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "email": "jsmith@example.com",
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "timeZoneId": "<string>",
  "billingPlan": "Annual",
  "subscriptionStatus": "Pending",
  "billingState": {
    "hasStripeCustomer": true,
    "hasPaymentMethod": true,
    "phoneNumberQuantity": 123,
    "organizationMemberQuantity": 123,
    "organizationMemberAssignedQuantity": 123,
    "pendingBillingPlan": "Annual",
    "billingPlanChangeEffectiveAt": "2023-11-07T05:31:56Z",
    "planRenewalAt": "2023-11-07T05:31:56Z",
    "planPeriodStartAt": "2023-11-07T05:31:56Z",
    "cancelAt": "2023-11-07T05:31:56Z",
    "dunning": {
      "stage": "<string>",
      "paymentFailedAt": "2023-11-07T05:31:56Z",
      "lastFailedInvoiceStatus": "<string>",
      "retryAttemptCount": 123,
      "nextRetryAt": "2023-11-07T05:31:56Z",
      "gracePeriodEndsAt": "2023-11-07T05:31:56Z",
      "outboundRestrictedAt": "2023-11-07T05:31:56Z",
      "outboundSuspendedAt": "2023-11-07T05:31:56Z",
      "finalCancellationAt": "2023-11-07T05:31:56Z",
      "lastUpdatedAt": "2023-11-07T05:31:56Z"
    },
    "lastSubscriptionEventAt": "2023-11-07T05:31:56Z",
    "lastPaymentMethodEventAt": "2023-11-07T05:31:56Z"
  },
  "roles": [
    "<string>"
  ],
  "identities": [
    {
      "issuer": "<string>",
      "issuerAssignedId": "<string>",
      "signInType": "<string>"
    }
  ],
  "currentOrganization": {
    "id": "<string>",
    "name": "<string>"
  },
  "compliance": {
    "acceptedTerms": true,
    "acceptedToSubscription": true,
    "acceptedSms": true,
    "acceptedBaa": true,
    "acceptedEmail": true,
    "trustedFormCertificates": [
      {
        "id": "<string>",
        "url": "<string>",
        "source": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "notificationPreferences": {
    "smsConsentOptedIn": true,
    "smsConsentUpdatedAt": "2023-11-07T05:31:56Z",
    "smsConsentTrustedFormCertificate": {
      "id": "<string>",
      "url": "<string>",
      "source": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "paymentFailedEnabled": true,
    "paymentFailedSmsEnabled": true,
    "lowWalletBalanceEnabled": true,
    "lowWalletBalanceEmailEnabled": true,
    "lowWalletBalanceSmsEnabled": true,
    "tenDlcStatusEnabled": true,
    "newLeadEnabled": true,
    "newLeadEmailEnabled": true,
    "newLeadSmsEnabled": true,
    "missedCallEnabled": true,
    "missedCallEmailEnabled": true,
    "missedCallSmsEnabled": true,
    "unreadSmsEnabled": true,
    "unreadSmsEmailEnabled": true,
    "unreadSmsSmsEnabled": true,
    "automationFailedEnabled": true,
    "automationFailedEmailEnabled": true,
    "automationFailedSmsEnabled": true,
    "billingEmailEnabled": true,
    "billingSmsEnabled": true,
    "subscriptionRenewingEnabled": true,
    "subscriptionRenewingEmailEnabled": true,
    "subscriptionRenewingSmsEnabled": true,
    "usageLimitHitEnabled": true
  },
  "mobileDevicePreferences": [
    {
      "device": {
        "id": "<string>",
        "name": "<string>"
      },
      "inboundPhoneCallsEnabled": true,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "lastLoggedInAt": "2023-11-07T05:31:56Z",
  "personalDataDeletionRequestedAt": "2023-11-07T05:31:56Z",
  "personalDataDeletedAt": "2023-11-07T05:31:56Z",
  "personalDataDeletionStatus": "<string>",
  "personalDataDeletionReason": "<string>",
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

Authorizations

Authorization

string

header

required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Body

The change billing plan request payload for the operation.

Defines the input used for change billing plan.

billingPlan

enum<string>

required

Billing plan for this billing plan.

Available options:

Annual,

Monthly

Response

Returns the user response.

Describes user data returned by Leadping.

string<email>

The email address associated with this user.

firstName

null | string

First name for this user.

lastName

null | string

Last name of the Leadping user.

phone

null | string

The phone number associated with this user.

timeZoneId

null | string

IANA time zone identifier used when displaying dates and times for this user.

billingPlan

null | enum<string>

Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.

Available options:

Annual,

Monthly

subscriptionStatus

null | enum<string>

Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.

Available options:

Pending,

Active,

Overdue,

Canceled

billingState

object | null

Customer-safe billing state for the user's currently selected organization.

Show child attributes

roles

null | string[]

The roles included with this user.

A Leadping user role value.

identities

null | object[]

The identities included with this user.

Show child attributes

currentOrganization

object | null

Current organization for this user.

Show child attributes

compliance

object | null

Compliance for this user.

Show child attributes

notificationPreferences

object | null

Notification preferences for this user.

Show child attributes

mobileDevicePreferences

null | object[]

The Leadping mobile device preferences for this user.

Show child attributes

lastLoggedInAt

null | string<date-time>

The date and time when this user last completed the Leadping sign-in flow.

personalDataDeletionRequestedAt

null | string<date-time>

UTC timestamp for personal data deletion requested at on this user.

personalDataDeletedAt

null | string<date-time>

UTC timestamp for personal data deleted at on this user.

personalDataDeletionStatus

null | string

The current personal data deletion status for this user.

personalDataDeletionReason

null | string

The human-readable personal data deletion reason explaining this user.

name

string

Human-readable display name of the resource.

string

Stable unique identifier of the resource.

createdAt

string<date-time>

UTC timestamp when the resource was created.

modifiedAt

null | string<date-time>

UTC timestamp when the resource was last modified, or null when it has not been updated.

API Overview

Endpoints

Change the current user's billing plan

Authorizations

Body

Response