1개의 조직 청구서 가져오기
- Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.
- 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.
기본 URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /orgs/{ORG-ID}/invoices/{INVOICE-ID}
요청 경로 매개변수
이름 | 유형 | 설명 |
---|---|---|
ORG-ID | 문자열 | 조직의 고유 식별자입니다. |
INVOICE-ID | 문자열 | 청구서의 고유 식별자입니다. 요금은 일반적으로 다음 날 게시됩니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 |
---|---|---|---|---|
pageNum | 숫자 | 옵션 | 결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다. | 1 |
itemsPerPage | 숫자 | 옵션 | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. | 100 |
pretty | 부울 | 옵션 | false | |
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 결과 목록을 반환하는 엔드포인트의 경우 | false |
backupJobsEnabledOnly | 부울 | 옵션 | 데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. backupJobsEnabled 플래그가 false 로 설정된 daemon 구성을 포함하려면 이 값을 false 로 설정합니다. | true |
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
쿼리 요소 envelope
를 true
로 설정하면 응답이 content
객체에 의해 래핑됩니다.
HTTP 응답은 다음 객체를 포함하는 JSON document를 반환합니다.
이름 | 유형 | 설명 | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
amountBilledCents | 숫자 | 이 청구서에 청구된 금액으로, subtotalCents + SalesTaxCents - StartingBalanceCents로 계산됩니다. | ||||||||||||||||||||||||||||||
amountPaidCents | 숫자 | 이 청구서에 대해 결제된 금액입니다. | ||||||||||||||||||||||||||||||
created | 문자열 | ISO 8601 의 타임스탬프 이 청구서가 생성된 시점의 UTC 날짜 및 시간 형식입니다. | ||||||||||||||||||||||||||||||
creditsCents | 숫자 | MongoDB에서 크레딧으로 제공하는 금액(USD 센트)입니다. | ||||||||||||||||||||||||||||||
endDate | 문자열 | ISO 8601 의 타임스탬프 이 청구서의 청구 기간이 종료된 날짜 및 시간 형식(UTC )입니다. | ||||||||||||||||||||||||||||||
groupId | 문자열 | 청구서가 연결된 프로젝트의 고유 식별자입니다. 모든 청구서에 표시되지는 않습니다. | ||||||||||||||||||||||||||||||
id | 문자열 | 이 청구서의 고유 식별자입니다. | ||||||||||||||||||||||||||||||
lineItems | 객체 배열 | 청구서의 항목입니다. 이 정보는 Cloud Manager UI 에 있는 청구서 페이지의 Usage Details 섹션에서도 찾을 수 있습니다. 배열 의 각 객체 에는 다음 필드가 포함되어 있습니다.
| ||||||||||||||||||||||||||||||
links | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. URL 간의 관계 유형은 웹 링크 사양 에 설명되어 있습니다. . | ||||||||||||||||||||||||||||||
orgId | 문자열 | 이 청구서를 받은 조직의 고유 식별자입니다. | ||||||||||||||||||||||||||||||
payments | 객체 배열 | 청구서에 적용된 결제 내역입니다.
| ||||||||||||||||||||||||||||||
refunds | 객체 배열 | 청구서에 대해 발행된 환불입니다.
| ||||||||||||||||||||||||||||||
salesTaxCents | 숫자 | subtotalCents 에 부과된 세금의 금액입니다. | ||||||||||||||||||||||||||||||
startDate | 문자열 | ISO 8601 의 타임스탬프 이 청구서 시작 날짜의 UTC 기준 날짜 및 시간 형식입니다. | ||||||||||||||||||||||||||||||
statusName | 문자열 | 이 청구서의 상태입니다. 허용되는 값은 다음과 같습니다.
| ||||||||||||||||||||||||||||||
subtotalCents | 숫자 | USD 센트 단위의 모든 양수 청구서 항목의 합계입니다. | ||||||||||||||||||||||||||||||
updated | 문자열 | ISO 8601 의 타임스탬프 청구서가 마지막으로 업데이트된 날짜 및 시간 형식(UTC )입니다. |
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}"
응답 예시
참고
다음 샘플 응답에서는 보기 쉽도록 lineItems
배열이 잘렸습니다.
{ "amountBilledCents" : 240, "amountPaidCents" : 240, "created" : "2018-04-01T06:14:31Z", "endDate" : "2018-05-01T00:00:00Z", "id" : "{INVOICE-ID}", "lineItems" : [ { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-05-01T04:05:31Z", "endDate" : "2018-05-01T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-30T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 }, { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-04-30T04:05:19Z", "endDate" : "2018-04-30T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-29T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 }, ... , { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-04-02T06:05:07Z", "endDate" : "2018-04-02T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-01T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 } ], "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}", "rel" : "http://mms.mongodb.com/org" }, { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}", "rel" : "self" } ], "orgId" : "{ORG-ID}", "payments" : [ { "amountBilledCents" : 240, "amountPaidCents" : 240, "created" : "2018-05-01T04:05:14Z", "id" : "{PAYMENT-ID}", "salesTaxCents" : 19, "statusName" : "PAID", "subtotalCents" : 221, "updated" : "2018-05-01T07:00:46Z" } ], "refunds" : [ ], "salesTaxCents" : 19, "startDate" : "2018-04-01T00:00:00Z", "startingBalanceCents" : 0, "statusName" : "PAID", "subtotalCents" : 221, "updated" : "2018-05-01T07:00:46Z"