user_account

Manage user's payment settings

Index

Path: GET /v7.0/user_accounts
Description: List user accounts
Authentication required: yes
Scope: user_account#index
Aliases: list
Blocking: no

Input parameters

Layout: object
Namespace: user_account

Parameter Type Required Details

from_id

From ID

Integer

no

List objects with IDs greater or lower than this value

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Validation error message: must be at least 0

limit

Limit

Integer

no

Number of objects to retrieve

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Maximum: `1000` (inclusive). Validation error message: must be between 0 and 1000

Output parameters

Layout: object_list
Namespace: user_accounts

Parameter	Type	Description
`id` Id	Integer
`monthly_payment` Monthly_payment	Integer
`paid_until` Paid_until	Datetime

Show

Path: GET /v7.0/user_accounts/{user_account_id}
Description: Show user account
Authentication required: yes
Scope: user_account#show
Aliases: find
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: object
Namespace: user_account

Parameter	Type	Description
`id` Id	Integer
`monthly_payment` Monthly_payment	Integer
`paid_until` Paid_until	Datetime

Update

Path: PUT /v7.0/user_accounts/{user_account_id}
Description: Update user account
Authentication required: yes
Scope: user_account#update
Aliases
Blocking: no

Input parameters

Layout: object
Namespace: user_account

Parameter	Type	Required	Details
`monthly_payment` Monthly_payment	Integer	no	Default: `null`
`paid_until` Paid_until	Datetime	no	Default: `null`

Output parameters

Layout: object
Namespace: user_account

Parameter	Type	Description
`id` Id	Integer
`monthly_payment` Monthly_payment	Integer
`paid_until` Paid_until	Datetime