Rigetti Computing account API
The account API from Rigetti Computing — 22 operation(s) for account.
Rigetti Computing account API is one of 9 APIs that Rigetti Computing publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include account. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 23 operations across 22 paths, and defines 32 schemas. It is described by OpenAPI 3.0.2, at version 2020-07-31.
Requests are made against a single base URL, https://api.qcs.rigetti.com.
23 operations
22 paths
32 schemas
1 DELETE16 GET4 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Rigetti Computing account API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (JWTBearer).
It accepts HTTP bearer tokens (JWT) (JWTBearerOptional).
JWTBearer— A JSON web token with sub or uid claim, as well as groups claim. If the token is absent, invalid or expired, the client will receive a 401 response. If the tok…JWTBearerOptional— Same as JWTBearer, but the Authorization header is optionally parsed. Clients will receive a 401 response if an invalid or expired token is provided. Otherwise…
Paths & Operations 23
Across 22 paths, the API surfaces 23 operations — 1 DELETE, 16 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
account 23
GET
/v1/groups/{groupName}/balance
Get Group Balance
GET
/v1/groups/{groupName}/billingCustomer
Retrieve billing customer for a QCS group account.
GET
/v1/groups/{groupName}/billingInvoices
Retrieve billing invoices for a QCS group account.
GET
/v1/groups/{groupName}/billingInvoices/{billingInvoiceId}/lines
Retrieve billing invoice lines for a QCS group account's invoice.
GET
/v1/groups/{groupName}/billingInvoices:getUpcoming
Retrieve upcoming invoice for QCS group billing customer.
GET
/v1/groups/{groupName}/billingInvoices:listUpcomingLines
List invoice lines for QCS group billing customer upcoming invoice.
GET
/v1/groups/{groupName}/users
List users belonging to a group
POST
/v1/groups:addUser
Add user to a group
POST
/v1/groups:removeUser
Remove user from a group.
GET
/v1/users/{userId}/balance
Get User Balance
GET
/v1/users/{userId}/billingCustomer
Retrieve billing customer for a QCS user account.
GET
/v1/users/{userId}/billingInvoices
Retrieve billing invoices for a QCS user account.
GET
/v1/users/{userId}/billingInvoices/{billingInvoiceId}/lines
Retrieve billing invoice lines for a QCS user account's invoice.
GET
/v1/users/{userId}/billingInvoices:getUpcoming
Retrieve upcoming invoice for QCS user billing customer.
GET
/v1/users/{userId}/billingInvoices:listUpcomingLines
List invoice lines for QCS user billing customer upcoming invoice.
POST
/v1/users/{userId}/eventBillingPrices:get
Retrieve EventBillingPrice for a user for a specific event. If no price is configured this operation will return a default EventBillingPrice for the specified product.
GET
/v1/users/{userId}/groups
List QCS groups for the requested user
POST
/v1/users:activate
Activate User
GET
/v1/viewer/announcements
List all announcements relevant to the authenticating user. By default, does not include dismissed announcements.
DELETE
/v1/viewer/announcements/{announcementId}
Dismiss an announcement for an authenticating user, indicating that they do not want to see it again.
PUT
/v1/viewer/userProfile
Update the profile of the authenticated user.
GET
/v1/viewer/onboardingCompleted
Get the onboarding status of the authenticated user.
PUT
/v1/viewer/onboardingCompleted
Update the onboarding status of the authenticated user.
Schemas 32
The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are BillingPrice (10 properties), BillingInvoiceLine (10 properties), BillingUpcomingInvoice (7 properties), Group (6 properties). Each schema is shown below with its type and property counts.
ValidationError
object
3 properties
2 required
Error
object
4 properties
3 required
AnnouncementsResponse
object
A page of announcements.
2 properties
1 required
BillingProduct
object
A QCS service product, such as reservation time or on-demand execution. One product can be associated with multiple prices, which may be associated to particul…
5 properties
3 required
BillingPrice
object
A configuration for calculating the cost of BillingProduct usage based on quantity, and when that cost should be added as an invoice item.
10 properties
1 required
BillingPriceScheme
string
Use perunit to charge a linear rate per quantity (recommended). Use tiered to charge a dynamic rate based on quantity as defined in the tiers of a BillingPice.
ListGroupUsersResponse
object
2 properties
1 required
ActivateUserRequest
object
3 properties
3 required
ListAccountBillingInvoicesResponse
object
2 properties
1 required
BillingCustomer
object
Billing account information of a particular QCS account.
2 properties
2 required
EventBillingPriceRate
object
The per-unit price associated with a particular QCS service product, and (optionally) with a particular quantum processor.
5 properties
2 required
Group
object
6 properties
6 required
BillingInvoiceStatus
string
ListAccountBillingInvoiceLinesResponse
object
2 properties
1 required
BillingPriceTiersMode
string
Use graduated to apply each tier calculation to the portion of relevant quantity, e.g. how US federal tax brackets work. Use volume to apply the highest releva…
ViewerUserOnboardingCompleted
object
1 property
1 required
BillingInvoiceLine
object
A line item on an invoice representing a particular purchase (such as a reservation) or aggregate usage for the invoice period.
10 properties
6 required
ListGroupsResponse
object
2 properties
1 required
UserCredentials
object
1 property
1 required
AccountBalance
object
Balance of QCS account in billing system. Note, a negative balance signifies that the account has QCS credits to spend. A positive account balance signifies th…
1 property
1 required
User
object
4 properties
3 required
BillingPriceRecurrence
object
How to invoice for the usage of a product that has a recurring (subscription) price.
4 properties
1 required
RemoveGroupUserRequest
object
Must provide either userId or userEmail and groupId or groupName.
4 properties
UserProfile
object
4 properties
4 required
UpdateViewerUserProfileRequest
object
3 properties
3 required
BillingInvoice
object
A finalized billing invoice.
AddGroupUserRequest
object
Must provide either userId or userEmail and groupId or groupName.
4 properties
BillingPriceTier
object
Use flatAmount to charge a fixed amount for the quantity relevant to the tier. Use unitAmount to charge a linear rate for the quantity relevant to the tier. On…
5 properties
1 required
Product
string
The set of known QCS service products.
Announcement
object
An announcement to be displayed to users.
4 properties
4 required
BillingUpcomingInvoice
object
An unfinalized billing invoice.
7 properties
7 required
GetAccountEventBillingPriceRequest
object
Property quantumProcessorId is currently required for all products, however in the future there may be products that do not require a quantumProcessorId.
2 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Rigetti Computing 8
Other APIs Rigetti Computing publishes across the network.
Rigetti Computing authentication API
Rigetti Computing clientApplications API
Rigetti Computing endpoints API
Rigetti Computing engagements API
Rigetti Computing Healthcheck API
Rigetti Computing quantumProcessors API
Rigetti Computing reservations API
Rigetti Computing Rigetti QCS API API
#account