Skip to main content
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 'Content-Type: application/json' \
  --data '
{
  "userId": "<string>"
}
'
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "roles": "<array>",
  "identities": [
    {
      "issuer": "<string>",
      "issuerAssignedId": "<string>",
      "signInType": "<string>"
    }
  ],
  "stripeInfo": {
    "customerId": "<string>",
    "defaultPaymentMethodId": "<string>",
    "subscriptionIds": [
      "<string>"
    ],
    "planSubscriptionId": "<string>",
    "planSubscriptionItemId": "<string>",
    "phoneSubscriptionId": "<string>",
    "phoneSubscriptionItemId": "<string>",
    "phoneNumberQuantity": "<string>",
    "businessUserSubscriptionItemId": "<string>",
    "businessUserQuantity": "<string>",
    "cancelAt": "2023-11-07T05:31:56Z",
    "cancellation": {
      "reasonCode": "<string>",
      "reason": "<string>",
      "competitor": "<string>",
      "missingFeature": "<string>",
      "technicalIssues": "<string>",
      "notes": "<string>",
      "cancelAtPeriodEnd": true,
      "requestedByUserId": "<string>",
      "requestedAt": "2023-11-07T05:31:56Z"
    },
    "dunning": {
      "stage": "<string>",
      "paymentFailedAt": "2023-11-07T05:31:56Z",
      "lastFailedInvoiceId": "<string>",
      "lastFailedInvoiceStatus": "<string>",
      "retryAttemptCount": "<string>",
      "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"
  },
  "business": {
    "id": "<string>",
    "name": "<string>"
  },
  "currentBusiness": {
    "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"
      }
    ],
    "licensedStates": [
      "<string>"
    ],
    "licensedProducts": [
      "<string>"
    ]
  },
  "notificationPreferences": {
    "paymentFailedEnabled": true,
    "lowWalletBalanceEnabled": true,
    "tenDlcStatusEnabled": true,
    "newLeadEnabled": true,
    "newLeadEmailEnabled": true,
    "newLeadSmsEnabled": true,
    "missedCallEnabled": true,
    "unreadSmsEnabled": true,
    "automationFailedEnabled": true,
    "billingEmailEnabled": true,
    "billingSmsEnabled": true,
    "subscriptionRenewingEnabled": true,
    "usageLimitHitEnabled": true
  },
  "mobileDevicePreferences": [
    {
      "deviceId": "<string>",
      "deviceName": "<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"
}

Body

The change billing plan request payload for the operation.

Request payload for change billing plan.

​
billingPlan
enum<string>

The billing plan value for this billing plan.

Available options:
Annual,
Monthly
​
userId
string | null

The user ID associated with this billing plan.

Response

Returns the user response.

API response containing user data returned to callers.

​
email
string

The email address associated with this user.

​
firstName
string | null

The first name value for this user.

​
lastName
string | null

The date and time for the last name value on this user.

​
phone
string | null

The phone number associated with this user.

​
billingPlan
enum<string> | null

Defines the supported Billing Plan values.

Available options:
Annual,
Monthly
​
subscriptionStatus
enum<string> | null

Defines the supported Subscription Status values.

Available options:
Pending,
Active,
Overdue,
Canceled
​
roles
array | null

The roles included with this user.

​
identities
object[] | null

The identities included with this user.

​
stripeInfo
object

The Stripe info value for this user.

​
business
object

The business value for this user.

​
currentBusiness
object

The current business value for this user.

​
compliance
object

The compliance value for this user.

​
notificationPreferences
object

The notification preferences value for this user.

​
mobileDevicePreferences
object[] | null

The Leadping mobile device preferences for this user.

​
lastLoggedInAt
string<date-time> | null

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

​
personalDataDeletionRequestedAt
string<date-time> | null

The date and time for the personal data deletion requested at value on this user.

​
personalDataDeletedAt
string<date-time> | null

The date and time for the personal data deleted at value on this user.

​
personalDataDeletionStatus
string | null

The current personal data deletion status for this user.

​
personalDataDeletionReason
string | null

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

​
name
string

The display name for the entity.

​
id
string

The unique identifier for the entity.

​
createdAt
string<date-time>

The date and time when the entity was created.

​
modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.