orb-billing
Version:
The official TypeScript library for the Orb API
31 lines • 1.35 kB
TypeScript
import { APIResource } from "../../resource.js";
import * as Core from "../../core.js";
import * as Shared from "../shared.js";
export declare class ExternalPriceID extends APIResource {
/**
* This endpoint allows you to update the `metadata` property on a price. If you
* pass null for the metadata value, it will clear any existing metadata for that
* price.
*/
update(externalPriceId: string, body: ExternalPriceIDUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Price>;
/**
* This endpoint returns a price given an external price id. See the
* [price creation API](/api-reference/price/create-price) for more information
* about external price aliases.
*/
fetch(externalPriceId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Price>;
}
export interface ExternalPriceIDUpdateParams {
/**
* User-specified key/value pairs for the resource. Individual keys can be removed
* by setting the value to `null`, and the entire metadata mapping can be cleared
* by setting `metadata` to `null`.
*/
metadata?: {
[key: string]: string | null;
} | null;
}
export declare namespace ExternalPriceID {
export { type ExternalPriceIDUpdateParams as ExternalPriceIDUpdateParams };
}
//# sourceMappingURL=external-price-id.d.ts.map