Availability and Rates APIs
Booking APIs
Property Mgmt APIs
Product management
ReferenceProduct management

deleteRatePlan mutation

Deletes a rate plan.

?? Why must the property ID be specified as an input parameter??

Syntax

1mutation {
2  deleteRatePlan(input: DeleteRatePlanInput!): DeleteRatePlanPayload
3}

Examples

1mutation {
2  deleteRatePlan (
3    input: {
4      propertyId: "15239776",
5      id:"381625050",
6      clientMutationId: "83920859203939f23k"
7    }
8  ) { 
9    propertyId
10    id
11    clientMutationId
12  }
13}

Arguments

NameDescription

input

Required.
Type: DeleteRatePlanInput

Types


Name
Type
DeleteRatePlanInput
InputObject

Details about the rate plan to delete.

FieldDescription
clientMutationId

Partner's transaction ID that uniquely identifies the request, which can be used to associate requests and responses for troubleshooting purposes. This ID must be unique across requests and cannot be reused. However, if a request needs to be retried, such as because it failed or timed out, the ID provided in the original request should be used. The ID can be in any format as long as it uniquely identifies the request.

Type: ID
idNot nullable.

Rate plan ID.

Type: ID
propertyIdNot nullable.

Property ID to which the rate plan belongs.

Type: ID
DeleteRatePlanPayload
Object

Payload after a rate plan is deleted.

FieldDescription
clientMutationId

Partner's transaction ID that identifies the request, which can be used to correlate with partner's transaction logs. This ID must be unique across requests and cannot be reused.

Type: ID
idNot nullable.

ID of the deleted rate plan.

Type: ID
propertyIdNot nullable.

Property ID to which the rate plan belonged.

Type: ID
ID
ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.