Clerk Android API/com.clerk.api.billing/Billing

Billing

Reads Clerk Billing data: Plans, Subscriptions, statements, payment attempts, and credits.

Methods that read a payer's data take an optional orgId: omit it for the signed-in user, or pass an Organization ID to read that Organization's data, which requires the org:sys_billing:read Permission.

Functions

getCreditBalance

suspend fun getCreditBalance(orgId: String? = null): ClerkResult<BillingCreditBalance, ClerkErrorResponse>

Gets the credit balance of the signed-in user, or of the Organization with orgId.

getCreditHistory

suspend fun getCreditHistory(orgId: String? = null, limit: Int = DEFAULT_BILLING_LIMIT, offset: Int = 0): ClerkResult<ClerkPaginatedResponse<BillingCreditLedger>, ClerkErrorResponse>

Lists the credit ledger entries of the signed-in user, or of the Organization with orgId.

getPaymentAttempt

suspend fun getPaymentAttempt(id: String, orgId: String? = null): ClerkResult<BillingPayment, ClerkErrorResponse>

Gets a payment attempt by ID.

getPaymentAttempts

suspend fun getPaymentAttempts(orgId: String? = null, limit: Int = DEFAULT_BILLING_LIMIT, offset: Int = 0): ClerkResult<ClerkPaginatedResponse<BillingPayment>, ClerkErrorResponse>

Lists the payment attempts of the signed-in user, or of the Organization with orgId.

getPlan

suspend fun getPlan(id: String): ClerkResult<BillingPlan, ClerkErrorResponse>

Gets a Plan by ID.

getPlans

suspend fun getPlans(forPayer: ForPayerType = ForPayerType.USER, orgId: String? = null, minSeats: Int? = null, limit: Int = DEFAULT_BILLING_LIMIT, offset: Int = 0): ClerkResult<ClerkPaginatedResponse<BillingPlan>, ClerkErrorResponse>

Lists your publicly visible Plans.

getStatement

suspend fun getStatement(id: String, orgId: String? = null): ClerkResult<BillingStatement, ClerkErrorResponse>

Gets a statement by ID.

getStatements

suspend fun getStatements(orgId: String? = null, limit: Int = DEFAULT_BILLING_LIMIT, offset: Int = 0): ClerkResult<ClerkPaginatedResponse<BillingStatement>, ClerkErrorResponse>

Lists the statements of the signed-in user, or of the Organization with orgId.

getSubscription

suspend fun getSubscription(orgId: String? = null): ClerkResult<BillingSubscription, ClerkErrorResponse>

Gets the Subscription of the signed-in user, or of the Organization with orgId.