Billing Type

BillingPlan

BillingPlan = “free” or “starter” or “scale”

BillingAddOn

**BillingAddOn**= “mobile” or “custom_dns”

BillingService

BillingService =

“input” or “output”or “analysis”or “data_records” or “sms” or “email” or “run_users” or “push_notification” or “file_storage”

BillingServicePrice

Attributes:

amount: int or float
Amount available in the service tier.
price: int or float
Price for the service tier.

BillingAllServicePrices

BillingAllServicePrices = dict[BillingService, list[BillingServicePrice]]

BillingPlanPrices

Attributes:

name: BillingPlan
Plan name.
price: int or float
Plan price.

BillingPlanPrices

BillingPlanPrices = list[BillingPlanPrices]

BillingAddOnPrices

Attributes:

name: BillingAddOn
Add-on name.
price: int or float
Add-on price.

BillingAddOnPrices

BillingAddOnPrices = list[BillingAddOnPrices]

BillingPrices

Attributes:

plans: BillingPlanPrices
Prices for each plan.
addons: BillingAddOnPrices
Prices for each add-on.

BillingAllServicePrices: BillingAllServicePrices

current_cycle

Attributes:

start: str
Date when the current cycle started.
end: str
Date when the current cycle ends.

BillingServiceSubscription

Attributes:

limit: int or float

BillingSubscriptionServices

BillingSubscriptionServices = dict[BillingService, BillingServiceSubscription]

BillingSubscriptionAddOns

BillingSubscriptionAddOns = dict[BillingAddOn, list[GenericID]]

BillingPaymentError

Attributes:

message: str or None

Payment error message.

details: str or None

More details on the payment error.

BillingPaymentPastDue

Attributes:

amount_due: int or float
Amount due that was not paid in a recurring payment.
attempt_count: int or float
Amount of attempts for the retried recurring payment.
invoice_url: str
URL for the invoice related to the failed recurring payment.

BillingSubscription

Attributes:

account: GenericID
Account ID.
plan: BillingPlan
Account plan.
services: BillingSubscriptionServices
Limits for each service in the account’s subscription.
addons: BillingSubscriptionAddOns
Add-ons in the account’s subscription.
current_cycle: current_cycle
Current cycle for the account’s subscription.
processing: bool
Whether changes are still being processed and awaiting response from Stripe.
payment_error: Optional[BillingPaymentError]
Payment errors in the account’s subscription.
past_due: Optional[BillingPaymentPastDue]
Past due information for recurring payment errors.
upcoming_invoice_total: int or float
Value of the upcoming invoice.
trial_end: str or None
Timestamp when the trial for the subscription ends if the subscription has a trial active.

BillingEditSubscription

Attributes:

plan: Optional[BillingPlan]
New account plan.
Only one of plan, services and addons is accepted.
services: Optional[BillingSubscriptionServices]
New limits for each service in the account’s subscription.
Only one of plan, services and addons is accepted.
addons: Optional[BillingSubscriptionAddOns]
Only one of plan, services and addons is accepted.
New add-ons in the account’s subscription.
coupon: Optional[str]
Coupon code.

BillingResourceAllocationServices

BillingResourceAllocationServices = dict[BillingService, Union[int, float]]

BillingProfileResourceAllocation

Attributes:

profile: GenericID
Profile ID.
updated_at: str
Timestamp when the resource allocation for the profile was last updated.

BillingResourceAllocationServices: BillingResourceAllocationServices

BillingProfileEditResourceAllocation

Attributes:

profile: Optional[GenericID]
Profile ID.

BillingResourceAllocationServices: Optional[BillingResourceAllocationServices]

BillingEditResourceAllocation

BillingEditResourceAllocation = list[BillingProfileEditResourceAllocation]