@swamp/gcp/cloudcommerceprocurement
v2026.04.23.1
Google Cloud cloudcommerceprocurement infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudcloudcommerceprocurementcloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/cloudcommerceprocurement@swamp/gcp/cloudcommerceprocurement/providers-accountsv2026.04.23.1providers_accounts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
getGet a accounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accounts |
syncSync accounts state from GCP
approveapprove
| Argument | Type | Description |
|---|---|---|
| approvalName? | any | |
| properties? | any | |
| reason? | any |
rejectreject
| Argument | Type | Description |
|---|---|---|
| approvalName? | any | |
| reason? | any |
resetreset
Resources
state(infinite)— Represents an account that was established by the customer on the service pro...
@swamp/gcp/cloudcommerceprocurement/providers-entitlementsv2026.04.23.1providers_entitlements.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account? | string | Output only. The resource name of the account that this entitlement is based on, if any. |
| cancellationReason? | string | Output only. The reason the entitlement was cancelled. If this entitlement wasn\ |
| consumers? | array | Output only. The resources using this entitlement, if applicable. |
| createTime? | string | Output only. The creation timestamp. |
| entitlementBenefitIds? | array | Output only. The entitlement benefit IDs associated with the purchase. |
| messageToUser? | string | Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes. |
| name? | string | Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`. |
| newOfferEndTime? | string | Output only. The end time of the new offer, determined from the offer's specified end date. If the offer des not have a specified end date then this field is not set. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_C |
| newOfferStartTime? | string | Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field isn't populated when the entitlement isn't yet approved. After the entitlement is approved, this field is populated with the effective time of the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PEN |
| newPendingOffer? | string | Output only. Upon a pending plan change, the name of the offer that the entitlement is switching to. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be eit |
| newPendingOfferDuration? | string | Output only. The duration of the new offer, in ISO 8601 duration format. This field is populated for pending offer changes. It isn't populated for entitlements which aren't active yet. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENT |
| newPendingPlan? | string | Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change. |
| offer? | string | Output only. The name of the offer that was procured. Field is empty if order wasn't made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't |
| offerDuration? | string | Output only. The offer duration of the current offer, in ISO 8601 duration format. This is empty if the entitlement wasn't made using an offer, or if the offer has a specified end date instead of a duration. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTI |
| offerEndTime? | string | Output only. End time for the current term of the Offer associated with this entitlement. The value of this field can change naturally over time due to auto-renewal, even if the offer isn't changed. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, then: * If the entitlement isn't approved yet approved, and the offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the |
| orderId? | string | Output only. The order ID of this entitlement, without any `orders/` resource name prefix. |
| plan? | string | Output only. The identifier of the plan that was procured. Required if the product has plans. |
| productExternalName? | string | Output only. The identifier of the product that was procured. |
| provider? | string | Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform. |
| quoteExternalName? | string | Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote. |
| state? | enum | Output only. The state of the entitlement. |
| subscriptionEndTime? | string | Output only. End time for the subscription corresponding to this entitlement. |
| updateTime? | string | Output only. The last update timestamp. |
| usageReportingId? | string | Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
getGet a entitlements
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the entitlements |
updateUpdate entitlements attributes
syncSync entitlements state from GCP
approveapprove
| Argument | Type | Description |
|---|---|---|
| entitlementMigrated? | any | |
| properties? | any |
approve_plan_changeapprove plan change
| Argument | Type | Description |
|---|---|---|
| pendingPlanName? | any |
rejectreject
| Argument | Type | Description |
|---|---|---|
| reason? | any |
reject_plan_changereject plan change
| Argument | Type | Description |
|---|---|---|
| pendingPlanName? | any | |
| reason? | any |
suspendsuspend
| Argument | Type | Description |
|---|---|---|
| reason? | any |
Resources
state(infinite)— Represents a procured product of a customer.
2026.04.03.324.3 KBApr 3, 2026
Google Cloud cloudcommerceprocurement infrastructure models
Release Notes
- Updated: providers_accounts, providers_entitlements
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcloudcommerceprocurementcloudinfrastructure
2026.04.03.124.0 KBApr 3, 2026
Google Cloud cloudcommerceprocurement infrastructure models
Release Notes
- Updated: providers_accounts, providers_entitlements
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcloudcommerceprocurementcloudinfrastructure
2026.04.02.224.0 KBApr 2, 2026
Google Cloud cloudcommerceprocurement infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcloudcommerceprocurementcloudinfrastructure
2026.03.27.123.5 KBMar 27, 2026
Google Cloud cloudcommerceprocurement infrastructure models
Release Notes
- Added: providers_accounts, providers_entitlements
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcloudcommerceprocurementcloudinfrastructure